pymetrics / cookiecutter-python-library

Cookiecutter template for a Python package.
BSD 3-Clause "New" or "Revised" License
0 stars 0 forks source link

====================== Cookiecutter PyPackage

.. image:: https://app.travis-ci.com/pymetrics/cookiecutter-python-library.svg?branch=master :target: https://app.travis-ci.com/github/pymetrics/cookiecutter-python-library :alt: Build Status

.. image:: https://readthedocs.org/projects/cookiecutter-python-library/badge/?version=latest :target: https://cookiecutter-python-library.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status

Cookiecutter_ template for a Python package.

Features

.. _Cookiecutter: https://github.com/cookiecutter/cookiecutter

Quickstart

Install the latest Cookiecutter if you haven't installed it yet (this requires Cookiecutter 1.4.0 or higher)::

pip install -U cookiecutter

Generate a Python package project::

cookiecutter https://github.com/pymetrics/cookiecutter-python-library.git

Then:

.. create a PyPI API token: https://pypi.org/manage/account/#api-tokens .. pip docs for requirements files: https://pip.pypa.io/en/stable/user_guide/#requirements-files .. _Register: https://packaging.python.org/tutorials/packaging-projects/#uploading-the-distribution-archives

For more details, see the cookiecutter-pypackage tutorial_.

.. _cookiecutter-pypackage tutorial: https://cookiecutter-pypackage.readthedocs.io/en/latest/tutorial.html

Credits



Forked from `@audryr's cookiecutter-pypackage`_.

.. _`@audryr's cookiecutter-pypackage`: https://github.com/audreyfeldroy/cookiecutter-pypackage

.. _Travis-CI: http://travis-ci.com/
.. _Tox: http://testrun.org/tox/
.. _Sphinx: http://sphinx-doc.org/
.. _Read the Docs: https://readthedocs.io/
.. _bump2version: https://github.com/c4urself/bump2version
.. _Punch: https://github.com/lgiordani/punch
.. _Poetry: https://python-poetry.org/
.. _PyPi: https://pypi.python.org/pypi
.. _Mkdocs: https://pypi.org/project/mkdocs/
.. _Pre-commit: https://pre-commit.com/
.. _Black: https://black.readthedocs.io/en/stable/
.. _Mypy: https://mypy.readthedocs.io/en/stable/