Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

Cookiecutter template for a Python package.
https://github.com/audreyfeldroy/cookiecutter-pypackage

Last synced: 29 days ago
JSON representation

Cookiecutter template for a Python package.

Awesome Lists containing this project

README 

        
======================

Cookiecutter PyPackage

======================



.. image:: https://pyup.io/repos/github/audreyfeldroy/cookiecutter-pypackage/shield.svg

    :target: https://pyup.io/repos/github/audreyfeldroy/cookiecutter-pypackage/

    :alt: Updates



.. image:: https://travis-ci.org/audreyfeldroy/cookiecutter-pypackage.svg?branch=master

    :target: https://travis-ci.org/github/audreyfeldroy/cookiecutter-pypackage

    :alt: Build Status



.. image:: https://readthedocs.org/projects/cookiecutter-pypackage/badge/?version=latest

    :target: https://cookiecutter-pypackage.readthedocs.io/en/latest/?badge=latest

    :alt: Documentation Status



Cookiecutter_ template for a Python package.



* GitHub repo: https://github.com/audreyfeldroy/cookiecutter-pypackage/

* Documentation: https://cookiecutter-pypackage.readthedocs.io/

* Free software: BSD license

* Discord: https://discord.gg/PWXJr3upUE



Features

--------



* Testing setup with ``unittest`` and ``python setup.py test`` or ``pytest``

* Travis-CI_: Ready for Travis Continuous Integration testing

* Tox_ testing: Setup to easily test for Python 3.6, 3.7, 3.8

* Sphinx_ docs: Documentation ready for generation with, for example, `Read the Docs`_

* bump2version_: Pre-configured version bumping with a single command

* Auto-release to PyPI_ when you push a new tag to master (optional)

* Command line interface using Click (optional)



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



Build Status

-------------



Linux:



.. image:: https://img.shields.io/travis/audreyfeldroy/cookiecutter-pypackage.svg

    :target: https://travis-ci.org/audreyfeldroy/cookiecutter-pypackage

    :alt: Linux build status on Travis CI



Windows:



.. image:: https://ci.appveyor.com/api/projects/status/github/audreyr/cookiecutter-pypackage?branch=master&svg=true

    :target: https://ci.appveyor.com/project/audreyr/cookiecutter-pypackage/branch/master

    :alt: Windows build status on Appveyor



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/audreyfeldroy/cookiecutter-pypackage.git



Then:



* Create a repo and put it there.

* Add the repo to your Travis-CI_ account.

* Install the dev requirements into a virtualenv. (``pip install -r requirements_dev.txt``)

* Register_ your project with PyPI.

* Run the Travis CLI command ``travis encrypt --add deploy.password`` to encrypt your PyPI password in Travis config

  and activate automated deployment on PyPI when you push a new tag to master branch.

* Add the repo to your `Read the Docs`_ account + turn on the Read the Docs service hook.

* Release your package by pushing a new tag to master.

* Add a ``requirements.txt`` file that specifies the packages you will need for

  your project and their versions. For more info see the `pip docs for requirements files`_.

* Activate your project on `pyup.io`_.



.. _`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



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, I 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.



Or Submit a Pull Request

~~~~~~~~~~~~~~~~~~~~~~~~



I also accept pull requests on this, if they're small, atomic, and if they

make my own packaging experience better.



.. _Travis-CI: http://travis-ci.org/

.. _Tox: http://testrun.org/tox/

.. _Sphinx: http://sphinx-doc.org/

.. _Read the Docs: https://readthedocs.io/

.. _`pyup.io`: https://pyup.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/



.. _`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