Skip to content
README.rst 1005 B
Newer Older
nimrod's avatar
nimrod committed
Sample Python project
#####################

nimrod's avatar
nimrod committed
.. image:: https://git.shore.co.il/nimrod/samplepyproject/badges/main/pipeline.svg
    :target: https://git.shore.co.il/nimrod/samplepyproject/-/commits/main
    :alt: pipeline status

nimrod's avatar
nimrod committed
A sample Python project. Meant as an instruction on creating a modern Python
package with just the standard Python tooling (setuptools, wheel) and without
additional tools like `Poetry <https://python-poetry.org/>`_, `Flit
<https://flit.pypa.io/>`_ or similar. This mainly revolves around using
:code:`pyproject.toml` in a standard wasy as specified in `PEP 621
<https://peps.python.org/pep-0621/>`_.

License
-------

This software is licensed under the MIT license (see the :code:`LICENSE.txt`
file).

Author
------

Nimrod Adar, `contact me <nimrod@shore.co.il>`_ or visit my `website
<https://www.shore.co.il/>`_. Patches are welcome via `git send-email
<http://git-scm.com/book/en/v2/Git-Commands-Email>`_. The repository is located
at: https://git.shore.co.il/nimrod/.