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

This page refers to the FERN.Lab version of cookiecutter pypackage, which is a fork of cookiecutter-pypackage_.

.. _cookiecutter: https://github.com/audreyfeldroy/cookiecutter-pypackage

For more information on the original package please see:

• GitHub repo: https://github.com/audreyfeldroy/cookiecutter-pypackage/
• Documentation: https://cookiecutter-pypackage.readthedocs.io/
• Free software: BSD license
• Discord: https://discord.gg/PWXJr3upUE

Features of FERN.Lab cookiecutter pypackage

• Testing setup with unittest or pytest
• Sphinx docs: Documentation ready for generation with, for example, Read the Docs
• Licence selection
• Auto-release to PyPI_ when you push a new tag to master (optional)
• Preparation to release on conda-forge
• Pre-commit_ tests to check code before pushing it to git

How to start

Please check the detailed instructions here: cookiecutter-pypackage tutorial_!

.. _cookiecutter-pypackage tutorial: https://github.com/FernLab/cookiecutter-py-package/blob/main/docs/tutorial.rst

Not Exactly What You Want?

Don't worry, you have options:

Similar Cookiecutter Templates

* `Nekroze/cookiecutter-pypackage`_: A fork of this with a PyTest test runner,
  strict flake8 checking with Travis/Tox, and some docs and ``setup.py`` differences.

* `tony/cookiecutter-pypackage-pythonic`_: Fork with py2.7+3.3 optimizations.
  Flask/Werkzeug-style test runner, ``_compat`` module and module/doc conventions.
  See ``README.rst`` or the `github comparison view`_ for exhaustive list of
  additions and modifications.

* `ardydedase/cookiecutter-pypackage`_: A fork with separate requirements files rather than a requirements list in the ``setup.py`` file.

* `lgiordani/cookiecutter-pypackage`_: A fork of Cookiecutter that uses Punch_ instead of bump2version_ and with separate requirements files.

* `briggySmalls/cookiecutter-pypackage`_: A fork using Poetry_ for neat package management and deployment, with linting, formatting, no makefiles and more.

* `veit/cookiecutter-namespace-template`_: A cookiecutter template for python modules with a namespace

* `zillionare/cookiecutter-pypackage`_: A template containing Poetry_, Mkdocs_, Github CI and many more. It's a template and a package also (can be installed with `pip`)

* `waynerv/cookiecutter-pypackage`_: A fork using Poetry_, Mkdocs_, Pre-commit_, Black_ and Mypy_. Run test, staging and release workflows with GitHub Actions, automatically generate release notes from CHANGELOG.

* Also see the `network`_ and `family tree`_ for this repo. (If you find
  anything that should be listed here, please add it and send a pull request!)

Fork This / Create Your Own

If you have differences in your preferred setup, we encourage you to fork this to create your own version. Or create your own; it doesn't strictly have to be a fork.

• Once you have your own version working, add it to the Similar Cookiecutter Templates list above with a brief description.

• It's up to you whether or not to rename your fork/own version. Do whatever you think sounds good.

.. _Sphinx: https://www.sphinx-doc.org/en/master/ .. _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/

.. Nekroze/cookiecutter-pypackage: https://github.com/Nekroze/cookiecutter-pypackage .. tony/cookiecutter-pypackage-pythonic: https://github.com/tony/cookiecutter-pypackage-pythonic .. ardydedase/cookiecutter-pypackage: https://github.com/ardydedase/cookiecutter-pypackage .. lgiordani/cookiecutter-pypackage: https://github.com/lgiordani/cookiecutter-pypackage .. briggySmalls/cookiecutter-pypackage: https://github.com/briggySmalls/cookiecutter-pypackage .. veit/cookiecutter-namespace-template: https://github.com/veit/cookiecutter-namespace-template .. zillionare/cookiecutter-pypackage: https://zillionare.github.io/cookiecutter-pypackage/ .. waynerv/cookiecutter-pypackage: https://waynerv.github.io/cookiecutter-pypackage/ .. github comparison view: https://github.com/tony/cookiecutter-pypackage-pythonic/compare/audreyr:master...master .. network: https://github.com/audreyr/cookiecutter-pypackage/network .. _family tree: https://github.com/audreyr/cookiecutter-pypackage/network/members