Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/veit/cookiecutter-namespace-template
Cookiecutter Namespace Template for a Python package.
https://github.com/veit/cookiecutter-namespace-template
cookiecutter cookiecutter-data-science cookiecutter-template jinja2-templates python-package
Last synced: 16 days ago
JSON representation
Cookiecutter Namespace Template for a Python package.
- Host: GitHub
- URL: https://github.com/veit/cookiecutter-namespace-template
- Owner: veit
- License: bsd-3-clause
- Created: 2018-09-06T14:54:14.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-11-27T20:19:52.000Z (about 2 months ago)
- Last Synced: 2024-11-27T21:24:57.815Z (about 2 months ago)
- Topics: cookiecutter, cookiecutter-data-science, cookiecutter-template, jinja2-templates, python-package
- Language: Python
- Homepage: https://cookiecutter-namespace-template.readthedocs.io/
- Size: 294 KB
- Stars: 11
- Watchers: 3
- Forks: 3
- Open Issues: 14
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.rst
Awesome Lists containing this project
README
===============================
Cookiecutter Namespace Template
===============================.. preface
`Cookiecutter `_ Namespace
Template for a Python package.|Downloads| |Versions| |Contributors| |License| |pre-commit.ci status| |Docs|
.. |Downloads| image:: https://pepy.tech/badge/cookiecutter-namespace-template
:target: https://pepy.tech/project/cookiecutter-namespace-template
.. |Versions| image:: https://img.shields.io/pypi/pyversions/cookiecutter-namespace-template.svg
:target: https://pypi.org/project/cookiecutter-namespace-template/
.. |Contributors| image:: https://img.shields.io/github/contributors/veit/cookiecutter-namespace-template.svg
:target: https://github.com/veit/cookiecutter-namespace-template/graphs/contributors
.. |License| image:: https://img.shields.io/github/license/veit/cookiecutter-namespace-template.svg
:target: https://github.com/veit/cookiecutter-namespace-template/blob/main/LICENSE
.. |pre-commit.ci status| image:: https://results.pre-commit.ci/badge/github/veit/cookiecutter-namespace-template/main.svg
:target: https://results.pre-commit.ci/latest/github/veit/cookiecutter-namespace-template/main
.. |Docs| image:: https://readthedocs.org/projects/cookiecutter-namespace-template/badge/?version=latest
:target: https://cookiecutter-namespace-template.readthedocs.io/en/latest/Features
--------.. Keep python versions of tox in sync with tox.ini.
* Testing setup with ``unittest`` or ``pytest``
* `Tox `_ testing: Setup to easily test for Python
3.9, 3.10, 3.11, 3.12, 3.13, and pypy.
* `Sphinx `_ docs: Documentation ready for
generation with, for example, ReadTheDocs_
* `Bump My Version `_:
Pre-configured version bumping with a single command
* If the `cookiecutter-namespace-template
`_ project template
has been changed, you can apply these changes with.. code-block:: console
$ cruft update
* Optional auto-release to `PyPI `_ when you push a new tag
to main (optional)
* Optional command line interface using `Typer `_ or
`Click `_Quickstart
----------#. Install the latest Cookiecutter if you haven’t installed it yet (this
requires Cookiecutter 1.4.0 or higher):.. code-block:: console
$ python -m pip install -U cruft
#. Generate a Python package project:
.. code-block:: console
$ python -m cruft create https://github.com/veit/cookiecutter-namespace-template.git
#. Create a repo and put it there.
#. `Register `_ your project with PyPI.
#. Add the repo to your `ReadTheDocs `_ account and
turn on the ReadTheDocs service hook.#. Release your package by pushing a new tag to main.
Pull requests
~~~~~~~~~~~~~If you have differences in your preferred setup, I encourage you to fork this
to create your own version. I also accept pull requests on this, if they’re
small, atomic, and if they make my own packaging experience better.