python3-pip-skeleton

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
Conda	conda install -c DiamondLightSource python3-pip-skeleton
Source code	DiamondLightSource/python3-pip-skeleton
Documentation	https://DiamondLightSource.github.io/python3-pip-skeleton
Releases	DiamondLightSource/python3-pip-skeleton

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

How the documentation is structured

The documentation is split into 2 sections:

The User Guide contains documentation on how to install and use python3-pip-skeleton.

The Developer Guide contains documentation on how to develop and contribute changes back to python3-pip-skeleton.