Skip to content
This repository has been archived by the owner on Mar 13, 2024. It is now read-only.

DiamondLightSource/python3-pip-skeleton

Repository files navigation

python3-pip-skeleton

Code CI Docs CI Test Coverage Latest PyPI version Apache License

Note

This project contains template code only. For documentation on how to adopt this skeleton project see https://DiamondLightSource.github.io/python3-pip-skeleton-cli

This is where you should write a short paragraph that describes what your module does, how it does it, and why people should use it.

PyPI pip install python3-pip-skeleton
Source code https://github.com/DiamondLightSource/python3-pip-skeleton
Documentation https://DiamondLightSource.github.io/python3-pip-skeleton
Releases https://github.com/DiamondLightSource/python3-pip-skeleton/releases

This is where you should put some images or code snippets that illustrate some relevant examples. If it is a library then you might put some introductory code here:

from python3_pip_skeleton import __version__

print(f"Hello python3_pip_skeleton {__version__}")

Or if it is a commandline tool then you might put some example commands here:

$ python -m python3_pip_skeleton --version

See https://DiamondLightSource.github.io/python3-pip-skeleton for more detailed documentation.