search

DiamondLightSource / python3-pip-skeleton

Archived in favour of https://github.com/DiamondLightSource/python-copier-template
Apache License 2.0
4 stars 4 forks source link

readme

python3-pip-skeleton

|code_ci| |docs_ci| |coverage| |pypi_version| |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:

.. code-block:: python

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

.. |code_ci| image:: https://github.com/DiamondLightSource/python3-pip-skeleton/actions/workflows/code.yml/badge.svg?branch=main :target: https://github.com/DiamondLightSource/python3-pip-skeleton/actions/workflows/code.yml :alt: Code CI

.. |docs_ci| image:: https://github.com/DiamondLightSource/python3-pip-skeleton/actions/workflows/docs.yml/badge.svg?branch=main :target: https://github.com/DiamondLightSource/python3-pip-skeleton/actions/workflows/docs.yml :alt: Docs CI

.. |coverage| image:: https://codecov.io/gh/DiamondLightSource/python3-pip-skeleton/branch/main/graph/badge.svg :target: https://codecov.io/gh/DiamondLightSource/python3-pip-skeleton :alt: Test Coverage

.. |pypi_version| image:: https://img.shields.io/pypi/v/python3-pip-skeleton.svg :target: https://pypi.org/project/python3-pip-skeleton :alt: Latest PyPI version

.. |license| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg :target: https://opensource.org/licenses/Apache-2.0 :alt: Apache License

.. Anything below this line is used when viewing README.rst and will be replaced when included in index.rst

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