https://github.com/nekmo/cookiecutter-python-package
https://github.com/nekmo/cookiecutter-python-package
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/nekmo/cookiecutter-python-package
- Owner: Nekmo
- Created: 2020-04-11T23:00:46.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-08T22:37:46.000Z (over 3 years ago)
- Last Synced: 2025-04-07T05:42:58.622Z (over 1 year ago)
- Language: Python
- Size: 361 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 19
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.rst
Awesome Lists containing this project
README
**MOVED TO ANOTHER REPOSITORY**: https://github.com/Nekmo/cookiecutter-python-package
============================
Python Project Cookie Cutter
============================
.. image:: https://pyup.io/repos/github/audreyr/cookiecutter-pypackage/shield.svg
:target: https://pyup.io/repos/github/audreyr/cookiecutter-pypackage/
:alt: Updates
Cookiecutter_ template for a Python package.
* GitHub repo: https://github.com/audreyr/cookiecutter-pypackage/
* Documentation: https://cookiecutter-pypackage.readthedocs.io/
* Free software: BSD license
Features
--------
* Package instalation using ``setup.cfg``.
* Testing setup with ``unittest`` and ``python setup.py test`` or ``py.test``
* Tox_ testing: Setup to easily test for Python 2.6, 2.7, 3.3, 3.4, 3.5
* Sphinx_ docs: Documentation ready for generation with, for example, ReadTheDocs_
* Bumpversion_: 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/audreyr/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/Nekmo/cookiecutter-pypackage.git
Then:
* Create a repo and put it there.
* Install the dev requirements into a virtualenv. (``pip install -r requirements_dev.txt``)
and activate automated deployment on PyPI when you push a new tag to master branch.
* Add the repo to your ReadTheDocs_ account + turn on the ReadTheDocs 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
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.
* 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.
.. _Tox: http://testrun.org/tox/
.. _Sphinx: http://sphinx-doc.org/
.. _ReadTheDocs: https://readthedocs.io/
.. _`pyup.io`: https://pyup.io/
.. _Bumpversion: https://github.com/peritus/bumpversion
.. _PyPi: https://pypi.python.org/pypi
.. _`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
.. _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