===============================
Cookiecutter Namespace Template
===============================
.. preface
`Cookiecutter <https://github.com/cookiecutter/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 <https://tox.wiki/en/latest/>`_ testing: Setup to easily test for Python
3.9, 3.10, 3.11, 3.12, 3.13, and pypy.
* `Sphinx <http://www.sphinx-doc.org/>`_ docs: Documentation ready for
generation with, for example, ReadTheDocs_
* `Bump My Version <https://github.com/callowayproject/bump-my-version>`_:
Pre-configured version bumping with a single command
* If the `cookiecutter-namespace-template
<https://github.com/veit/cookiecutter-namespace-template>`_ project template
has been changed, you can apply these changes with
.. code-block:: console
$ cruft update
* Optional auto-release to `PyPI <https://pypi.org/>`_ when you push a new tag
to main (optional)
* Optional command line interface using `Typer <https://typer.tiangolo.com>`_ or
`Click <https://palletsprojects.com/p/click/>`_
If you really want to create a new package with Python 2, in spite of the
`Python 2.7 countdown <https://pythonclock.org/>`_ and the `Sunsetting Python 2
support <https://python3statement.org/>`_, then use
``cookiecutter-namespace-template`` <0.2.
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 <https://pypi.org/account/register/>`_ your project with PyPI.
#. Add the repo to your `ReadTheDocs <https://readthedocs.io/>`_ 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "cookiecutter-namespace-template",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "cookiecutter, package, template",
"author": null,
"author_email": "Veit Schiele <veit@cusy.io>",
"download_url": "https://files.pythonhosted.org/packages/17/c9/6e05a926a4f6d9e65d91217dd38af58ea3cc9ea1ae13a21f6303eed99ee7/cookiecutter_namespace_template-24.2.0.tar.gz",
"platform": null,
"description": "===============================\nCookiecutter Namespace Template\n===============================\n\n.. preface\n\n`Cookiecutter <https://github.com/cookiecutter/cookiecutter>`_ Namespace\nTemplate for a Python package.\n\n|Downloads| |Versions| |Contributors| |License| |pre-commit.ci status| |Docs|\n\n.. |Downloads| image:: https://pepy.tech/badge/cookiecutter-namespace-template\n :target: https://pepy.tech/project/cookiecutter-namespace-template\n.. |Versions| image:: https://img.shields.io/pypi/pyversions/cookiecutter-namespace-template.svg\n :target: https://pypi.org/project/cookiecutter-namespace-template/\n.. |Contributors| image:: https://img.shields.io/github/contributors/veit/cookiecutter-namespace-template.svg\n :target: https://github.com/veit/cookiecutter-namespace-template/graphs/contributors\n.. |License| image:: https://img.shields.io/github/license/veit/cookiecutter-namespace-template.svg\n :target: https://github.com/veit/cookiecutter-namespace-template/blob/main/LICENSE\n.. |pre-commit.ci status| image:: https://results.pre-commit.ci/badge/github/veit/cookiecutter-namespace-template/main.svg\n :target: https://results.pre-commit.ci/latest/github/veit/cookiecutter-namespace-template/main\n.. |Docs| image:: https://readthedocs.org/projects/cookiecutter-namespace-template/badge/?version=latest\n :target: https://cookiecutter-namespace-template.readthedocs.io/en/latest/\n\nFeatures\n--------\n\n.. Keep python versions of tox in sync with tox.ini.\n\n* Testing setup with ``unittest`` or ``pytest``\n* `Tox <https://tox.wiki/en/latest/>`_ testing: Setup to easily test for Python\n 3.9, 3.10, 3.11, 3.12, 3.13, and pypy.\n* `Sphinx <http://www.sphinx-doc.org/>`_ docs: Documentation ready for\n generation with, for example, ReadTheDocs_\n* `Bump My Version <https://github.com/callowayproject/bump-my-version>`_:\n Pre-configured version bumping with a single command\n* If the `cookiecutter-namespace-template\n <https://github.com/veit/cookiecutter-namespace-template>`_ project template\n has been changed, you can apply these changes with\n\n .. code-block:: console\n\n $ cruft update\n\n* Optional auto-release to `PyPI <https://pypi.org/>`_ when you push a new tag\n to main (optional)\n* Optional command line interface using `Typer <https://typer.tiangolo.com>`_ or\n `Click <https://palletsprojects.com/p/click/>`_\n\nIf you really want to create a new package with Python 2, in spite of the\n`Python 2.7 countdown <https://pythonclock.org/>`_ and the `Sunsetting Python 2\nsupport <https://python3statement.org/>`_, then use\n``cookiecutter-namespace-template`` <0.2.\n\nQuickstart\n----------\n\n#. Install the latest Cookiecutter if you haven\u2019t installed it yet (this\n requires Cookiecutter 1.4.0 or higher):\n\n .. code-block:: console\n\n $ python -m pip install -U cruft\n\n#. Generate a Python package project:\n\n .. code-block:: console\n\n $ python -m cruft create https://github.com/veit/cookiecutter-namespace-template.git\n\n#. Create a repo and put it there.\n\n#. `Register <https://pypi.org/account/register/>`_ your project with PyPI.\n\n#. Add the repo to your `ReadTheDocs <https://readthedocs.io/>`_ account and\n turn on the ReadTheDocs service hook.\n\n#. Release your package by pushing a new tag to main.\n\nPull requests\n~~~~~~~~~~~~~\n\nIf you have differences in your preferred setup, I encourage you to fork this\nto create your own version. I also accept pull requests on this, if they\u2019re\nsmall, atomic, and if they make my own packaging experience better.\n",
"bugtrack_url": null,
"license": null,
"summary": "Cookiecutter template for a Python namespace package",
"version": "24.2.0",
"project_urls": {
"Bug Tracker": "https://github.com/veit/cookiecutter-namespace-template/issues",
"Documentation": "https://cookiecutter-namespace-template.readthedocs.io/",
"Source Code": "https://github.com/veit/cookiecutter-namespace-template"
},
"split_keywords": [
"cookiecutter",
" package",
" template"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4eed971c0205389c4c117e1fa4f9b1d41aa771cfde59af4abdede5cb2b642eba",
"md5": "a9ab4a90ee502a134d50fec1f50de5f9",
"sha256": "fc0de6440438963feb253e06d58775dfbe85368563577d6f6394b706ec957b5d"
},
"downloads": -1,
"filename": "cookiecutter_namespace_template-24.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a9ab4a90ee502a134d50fec1f50de5f9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 55269,
"upload_time": "2024-10-10T15:40:46",
"upload_time_iso_8601": "2024-10-10T15:40:46.858476Z",
"url": "https://files.pythonhosted.org/packages/4e/ed/971c0205389c4c117e1fa4f9b1d41aa771cfde59af4abdede5cb2b642eba/cookiecutter_namespace_template-24.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "17c96e05a926a4f6d9e65d91217dd38af58ea3cc9ea1ae13a21f6303eed99ee7",
"md5": "6189f38bdca7178d4e49c13661d9e751",
"sha256": "81144972d3e71d61e3c7696359981b382c1813960a304f188c6896781e5ebabc"
},
"downloads": -1,
"filename": "cookiecutter_namespace_template-24.2.0.tar.gz",
"has_sig": false,
"md5_digest": "6189f38bdca7178d4e49c13661d9e751",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 33732,
"upload_time": "2024-10-10T15:40:48",
"upload_time_iso_8601": "2024-10-10T15:40:48.978984Z",
"url": "https://files.pythonhosted.org/packages/17/c9/6e05a926a4f6d9e65d91217dd38af58ea3cc9ea1ae13a21f6303eed99ee7/cookiecutter_namespace_template-24.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-10 15:40:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "veit",
"github_project": "cookiecutter-namespace-template",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "cookiecutter-namespace-template"
}
JSON
