cookiecutter-python


Namecookiecutter-python JSON
Version 2.4.0 PyPI version JSON
download
home_pagehttps://github.com/boromir674/cookiecutter-python-package
Summary1-click Generator of Python Project, from Template with streamlined "DevOps" using a powerful CI/CD Pipeline.
upload_time2024-03-14 14:23:22
maintainerKonstantinos Lampridis
docs_urlNone
authorKonstantinos Lampridis
requires_python>=3.7,<3.13
licenseAGPL-3.0-only
keywords python package generator python package template cookiecutter python package automation
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            ========================
Python Package Generator
========================

| |build| |coverage| |docs| |maintainability| |codacy| |tech-debt|
| |release_version| |wheel| |supported_versions| |commits_since_specific_tag_on_master| |commits_since_latest_github_release|
| |pypi_stats| |ossf| |ruff| |black| |gh-lic|

|
| **Generate** Python Project and enjoy **streamlined DevOps** using a powerful **CI/CD Pipeline.**
|
| **Documentation** available at https://python-package-generator.readthedocs.io/.


What's included?
================

* **Generator** of **Python Project** (see `Quickstart`_), with **CLI** for **Linux**, **MacOS**, and **Windows**
* **Option** to Generate Python Package designed as `module`, `module+cli`, or `pytest-plugin`!
* Scaffold over **24 files**, from `Template`_, to have a `ready-to-develop` **Project equipped** with:

  * Fully-featured **CI/CD Pipeline**, running on `Github Actions`_, defined in `.github/`
  * **Continuous Delivery** to *PyPI* (i.e. `pypi.org`_, `test.pypi.org`_) and *Dockerhub*
  * **Continuous Integration**, with **Test Suite** running `pytest`_, located in the `tests` dir
  * **Continuous Documentation**, building with `mkdocs` or `sphinx`, and hosting on `readthedocs`, located in the `docs` dir
  * **Static Type Checking**, using `mypy`_
  * **Lint** *Check* and `Apply` commands, using the fast `Ruff`_ linter, along with standard `isort`_, and `black`_
  * **Build Command**, using the `build`_ python package



What to expect?
===============

You can to be up and running with a new Python Package, and run workflows on Github Actions, such as:

.. image is expected to mostly be rendered on github.com, pypi.org, readthedocs.io
   in any case we care for these pages. Adjust images props (ie width if needed)

.. image:: https://raw.githubusercontent.com/boromir674/cookiecutter-python-package/master/docs/assets/CICD-Pipe.png
   :alt: CI Pipeline, running on Github Actions, for a Biskotaki Python Package
   :align: center
   :width: 100%

Link: https://github.com/boromir674/biskotaki/actions/runs/4157571651

1. **CI Pipeline**, running on `Github Actions`_, defined in `.github/`

   a. **Job Matrix**, spanning different `platform`'s and `python version`'s

      1. Platforms: `ubuntu-latest`, `macos-latest`
      2. Python Interpreters: `3.7`, `3.8`, `3.9`, `3.10`, `3.11`, `3.12`
   b. **Parallel Job** execution, generated from the `matrix`, that runs the `Test Suite`
   c. **Artifact** store of **Source** and **Wheel** Distributions, factoring Platform and Python Version


Auto Generated Sample Package **Biskotaki**
-------------------------------------------

Check the **Biskotaki** *Python Package Project*, for a taste of the project structure and capabilities this Template can generate!

It it entirely generated using this **Python Package Template:**

| **Source Code** hosted on *Github* at https://github.com/boromir674/biskotaki
| **Python Package** hosted on *pypi.org* at https://pypi.org/project/biskotaki/
| **CI Pipeline** hosted on *Github Actions* at https://github.com/boromir674/biskotaki/actions


Quickstart
==========

To **install** the latest ``Generator`` in your environment, run:

.. code-block:: shell

    pip install cookiecutter-python

The ``generate-python`` (executable) CLI should now be available in your environment.

Next, **create** a file, let's call it ``gen-config.yml``, with the following content:

.. code-block:: yaml

    default_context:
        project_name: Demo Generated Project
        project_type: module+cli
        full_name: John Doe
        email: john.doe@something.org
        github_username: john-doe
        project_short_description: 'Demo Generated Project Description'
        initialize_git_repo: 'no'
        interpreters: {"supported-interpreters": ["3.8", "3.9", "3.10", "3.11"]}


To **generate** a Python Package Project, run:

.. code-block:: sh

    mkdir gen-demo-dir
    cd gen-demo-dir
    
    generate-python --config-file ../gen-config.yml --no-input


Now, you should have generated a new Project for a Python Package, based on the `Template`_!

The Project should be located in the newly created ``demo-generated-project`` directory.


To leverage all out-of-the-box development operations (ie scripts), install `tox`_:

.. code-block:: shell

    python3 -m pip install --user 'tox==3.27.1'

To verify tox available in your environment, run: ``tox --version``


Please, do a `cd` into the newly created directory, ie `cd <my-great-python-package>`.

To run the Test Suite, `cd` into the newly created Project folder, and run:

.. code-block:: shell

    tox -e dev

All Tests should pass, and you should see a `coverage` report!


To run Type Checking against the Source Code, run:

.. code-block:: shell

    tox -e type

All Type Checks should pass!


To setup a Git Repository, run:

.. code-block:: shell

    git init
    git add .
    git checkout -b main
    git commit -m "Initial commit"


To setup a Remote Repository, run for example:

.. code-block:: shell

    git remote add origin <remote-repository-url>
    git push -u origin main


To trigger the CI/CD Pipeline, run:

.. code-block:: shell

    git push

Navigate to your github.com/username/your-repo/actions page, to see the CI Pipeline running!

| Develop your package's **Source Code** (`business logic`) inside `src/my_great_python_package` dir :)
| Develop your package's **Test Suite** (ie `unit-tests`, `integration tests`) inside `tests` dir :-)

Read the Documentation's `Use Cases`_ section for more on how to leverage your generated Python Package features.


Next Steps
----------

To prepare for an Open Source Project Development Lifecycle, you should visit the following websites:

* PyPI, test.pypi.org, Dockerhub, and Read the Docs, for setting up Release and Documentation Pipelines
* github.com/your-account to configure Actions, through the web UI
* Codecov, Codacy, and Codeclimate, for setting up Automated Code Quality, with CI Pipelines
* https://www.bestpractices.dev/ for registering your Project for OpenSSF Best Practices Badge

**Happy Developing!**

License
=======

|gh-lic|

* `GNU Affero General Public License v3.0`_


Free/Libre and Open Source Software (FLOSS)
-------------------------------------------

|ossf|




.. URL LINKS

.. _Cookiecutter documentation: https://cookiecutter.readthedocs.io/en/stable/

.. _CI: https://github.com/boromir674/cookiecutter-python-package/actions

.. _tox: https://tox.wiki/en/latest/

.. _pytest: https://docs.pytest.org/en/7.1.x/

.. _build: https://github.com/pypa/build

.. _pypi.org: https://pypi.org/

.. _test.pypi.org: https://test.pypi.org/

.. _mypy: https://mypy.readthedocs.io/en/stable/

.. _Github Actions: https://github.com/boromir674/cookiecutter-python-package/actions

.. _src/cookiecutter_python/: https://github.com/boromir674/cookiecutter-python-package/tree/master/src/cookiecutter_python

.. _Template: https://github.com/boromir674/cookiecutter-python-package/tree/master/src/cookiecutter_python/%7B%7B%20cookiecutter.project_slug%20%7D%7D

.. _Use Cases: https://python-package-generator.readthedocs.io/en/master/contents/30_usage/index.html#new-python-package-use-cases

.. _GNU Affero General Public License v3.0: https://github.com/boromir674/cookiecutter-python-package/blob/master/LICENSE

.. _Ruff: https://docs.astral.sh/ruff/

.. _isort: https://pycqa.github.io/isort/

.. _black: https://black.readthedocs.io/en/stable/



.. BADGE ALIASES

.. Build Status
.. Github Actions: Test Workflow Status for specific branch <branch>

.. |build| image:: https://img.shields.io/github/actions/workflow/status/boromir674/cookiecutter-python-package/test.yaml?link=https%3A%2F%2Fgithub.com%2Fboromir674%2Fcookiecutter-python-package%2Factions%2Fworkflows%2Ftest.yaml%3Fquery%3Dbranch%253Amaster
   :alt: GitHub Workflow Status (with event)

.. build target https://github.com/boromir674/cookiecutter-python-package/actions/workflows/test.yaml?query=branch%3Amaster


.. Documentation

.. |docs| image:: https://img.shields.io/readthedocs/python-package-generator/master?logo=readthedocs&logoColor=lightblue
    :alt: Read the Docs (version)
    :target: https://python-package-generator.readthedocs.io/en/master/

.. Code Coverage

.. |coverage| image:: https://img.shields.io/codecov/c/github/boromir674/cookiecutter-python-package/master?logo=codecov
    :alt: Codecov
    :target: https://app.codecov.io/gh/boromir674/cookiecutter-python-package

.. PyPI

.. |release_version| image:: https://img.shields.io/pypi/v/cookiecutter_python
    :alt: Production Version
    :target: https://pypi.org/project/cookiecutter-python/

.. |wheel| image:: https://img.shields.io/pypi/wheel/cookiecutter-python?color=green&label=wheel
    :alt: PyPI - Wheel
    :target: https://pypi.org/project/cookiecutter-python

.. |supported_versions| image:: https://img.shields.io/pypi/pyversions/cookiecutter-python?color=blue&label=python&logo=python&logoColor=%23ccccff
    :alt: Supported Python versions
    :target: https://pypi.org/project/cookiecutter-python

.. |pypi_stats| image:: https://img.shields.io/pypi/dm/cookiecutter-python?logo=pypi&logoColor=%23849ED9&color=%23849ED9&link=https%3A%2F%2Fpypi.org%2Fproject%2Fcookiecutter-python%2F&link=https%3A%2F%2Fpypistats.org%2Fpackages%2Fcookiecutter-python
    :alt: PyPI - Downloads
    :target: https://pypistats.org/packages/cookiecutter-python

.. Github Releases & Tags

.. |commits_since_specific_tag_on_master| image:: https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/v2.4.0/master?color=blue&logo=github
    :alt: GitHub commits since tagged version (branch)
    :target: https://github.com/boromir674/cookiecutter-python-package/compare/v2.4.0..master

.. |commits_since_latest_github_release| image:: https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/latest?color=blue&logo=semver&sort=semver
    :alt: GitHub commits since latest release (by SemVer)


.. LICENSE (eg AGPL, MIT)
.. Github License

.. |gh-lic| image:: https://img.shields.io/github/license/boromir674/cookiecutter-python-package
    :alt: GitHub
    :target: https://github.com/boromir674/cookiecutter-python-package/blob/master/LICENSE


.. Free/Libre Open Source Software
.. Open Source Software Best Practices

.. |ossf| image:: https://bestpractices.coreinfrastructure.org/projects/5988/badge
    :alt: OpenSSF
    :target: https://bestpractices.coreinfrastructure.org/en/projects/5988


.. CODE QUALITY

.. Codacy
.. Code Quality, Style, Security

.. |codacy| image:: https://app.codacy.com/project/badge/Grade/5be4a55ff1d34b98b491dc05e030f2d7
    :alt: Codacy
    :target: https://app.codacy.com/gh/boromir674/cookiecutter-python-package/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=boromir674/cookiecutter-python-package&amp;utm_campaign=Badge_Grade


.. Code Climate CI
.. Code maintainability & Technical Debt

.. |maintainability| image:: https://api.codeclimate.com/v1/badges/1d347d7dfaa134fd944e/maintainability
   :alt: Maintainability
   :target: https://codeclimate.com/github/boromir674/cookiecutter-python-package/

.. |tech-debt| image:: https://img.shields.io/codeclimate/tech-debt/boromir674/cookiecutter-python-package
    :alt: Code Climate technical debt
    :target: https://codeclimate.com/github/boromir674/cookiecutter-python-package/

.. Ruff linter for Fast Python Linting

.. |ruff| image:: https://img.shields.io/badge/code%20style-ruff-000000.svg
    :alt: Ruff
    :target: https://docs.astral.sh/ruff/

.. Code Style with Black

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :alt: Black
    :target: https://github.com/psf/black


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/boromir674/cookiecutter-python-package",
    "name": "cookiecutter-python",
    "maintainer": "Konstantinos Lampridis",
    "docs_url": null,
    "requires_python": ">=3.7,<3.13",
    "maintainer_email": "k.lampridis@hotmail.com",
    "keywords": "python package generator,python package template,cookiecutter,python package,automation",
    "author": "Konstantinos Lampridis",
    "author_email": "k.lampridis@hotmail.com",
    "download_url": "https://files.pythonhosted.org/packages/2e/43/6f8f9f0c966c1e6992b5ea99a56f985ce9dd713db8b193bec756851bbece/cookiecutter_python-2.4.0.tar.gz",
    "platform": null,
    "description": "========================\nPython Package Generator\n========================\n\n| |build| |coverage| |docs| |maintainability| |codacy| |tech-debt|\n| |release_version| |wheel| |supported_versions| |commits_since_specific_tag_on_master| |commits_since_latest_github_release|\n| |pypi_stats| |ossf| |ruff| |black| |gh-lic|\n\n|\n| **Generate** Python Project and enjoy **streamlined DevOps** using a powerful **CI/CD Pipeline.**\n|\n| **Documentation** available at https://python-package-generator.readthedocs.io/.\n\n\nWhat's included?\n================\n\n* **Generator** of **Python Project** (see `Quickstart`_), with **CLI** for **Linux**, **MacOS**, and **Windows**\n* **Option** to Generate Python Package designed as `module`, `module+cli`, or `pytest-plugin`!\n* Scaffold over **24 files**, from `Template`_, to have a `ready-to-develop` **Project equipped** with:\n\n  * Fully-featured **CI/CD Pipeline**, running on `Github Actions`_, defined in `.github/`\n  * **Continuous Delivery** to *PyPI* (i.e. `pypi.org`_, `test.pypi.org`_) and *Dockerhub*\n  * **Continuous Integration**, with **Test Suite** running `pytest`_, located in the `tests` dir\n  * **Continuous Documentation**, building with `mkdocs` or `sphinx`, and hosting on `readthedocs`, located in the `docs` dir\n  * **Static Type Checking**, using `mypy`_\n  * **Lint** *Check* and `Apply` commands, using the fast `Ruff`_ linter, along with standard `isort`_, and `black`_\n  * **Build Command**, using the `build`_ python package\n\n\n\nWhat to expect?\n===============\n\nYou can to be up and running with a new Python Package, and run workflows on Github Actions, such as:\n\n.. image is expected to mostly be rendered on github.com, pypi.org, readthedocs.io\n   in any case we care for these pages. Adjust images props (ie width if needed)\n\n.. image:: https://raw.githubusercontent.com/boromir674/cookiecutter-python-package/master/docs/assets/CICD-Pipe.png\n   :alt: CI Pipeline, running on Github Actions, for a Biskotaki Python Package\n   :align: center\n   :width: 100%\n\nLink: https://github.com/boromir674/biskotaki/actions/runs/4157571651\n\n1. **CI Pipeline**, running on `Github Actions`_, defined in `.github/`\n\n   a. **Job Matrix**, spanning different `platform`'s and `python version`'s\n\n      1. Platforms: `ubuntu-latest`, `macos-latest`\n      2. Python Interpreters: `3.7`, `3.8`, `3.9`, `3.10`, `3.11`, `3.12`\n   b. **Parallel Job** execution, generated from the `matrix`, that runs the `Test Suite`\n   c. **Artifact** store of **Source** and **Wheel** Distributions, factoring Platform and Python Version\n\n\nAuto Generated Sample Package **Biskotaki**\n-------------------------------------------\n\nCheck the **Biskotaki** *Python Package Project*, for a taste of the project structure and capabilities this Template can generate!\n\nIt it entirely generated using this **Python Package Template:**\n\n| **Source Code** hosted on *Github* at https://github.com/boromir674/biskotaki\n| **Python Package** hosted on *pypi.org* at https://pypi.org/project/biskotaki/\n| **CI Pipeline** hosted on *Github Actions* at https://github.com/boromir674/biskotaki/actions\n\n\nQuickstart\n==========\n\nTo **install** the latest ``Generator`` in your environment, run:\n\n.. code-block:: shell\n\n    pip install cookiecutter-python\n\nThe ``generate-python`` (executable) CLI should now be available in your environment.\n\nNext, **create** a file, let's call it ``gen-config.yml``, with the following content:\n\n.. code-block:: yaml\n\n    default_context:\n        project_name: Demo Generated Project\n        project_type: module+cli\n        full_name: John Doe\n        email: john.doe@something.org\n        github_username: john-doe\n        project_short_description: 'Demo Generated Project Description'\n        initialize_git_repo: 'no'\n        interpreters: {\"supported-interpreters\": [\"3.8\", \"3.9\", \"3.10\", \"3.11\"]}\n\n\nTo **generate** a Python Package Project, run:\n\n.. code-block:: sh\n\n    mkdir gen-demo-dir\n    cd gen-demo-dir\n    \n    generate-python --config-file ../gen-config.yml --no-input\n\n\nNow, you should have generated a new Project for a Python Package, based on the `Template`_!\n\nThe Project should be located in the newly created ``demo-generated-project`` directory.\n\n\nTo leverage all out-of-the-box development operations (ie scripts), install `tox`_:\n\n.. code-block:: shell\n\n    python3 -m pip install --user 'tox==3.27.1'\n\nTo verify tox available in your environment, run: ``tox --version``\n\n\nPlease, do a `cd` into the newly created directory, ie `cd <my-great-python-package>`.\n\nTo run the Test Suite, `cd` into the newly created Project folder, and run:\n\n.. code-block:: shell\n\n    tox -e dev\n\nAll Tests should pass, and you should see a `coverage` report!\n\n\nTo run Type Checking against the Source Code, run:\n\n.. code-block:: shell\n\n    tox -e type\n\nAll Type Checks should pass!\n\n\nTo setup a Git Repository, run:\n\n.. code-block:: shell\n\n    git init\n    git add .\n    git checkout -b main\n    git commit -m \"Initial commit\"\n\n\nTo setup a Remote Repository, run for example:\n\n.. code-block:: shell\n\n    git remote add origin <remote-repository-url>\n    git push -u origin main\n\n\nTo trigger the CI/CD Pipeline, run:\n\n.. code-block:: shell\n\n    git push\n\nNavigate to your github.com/username/your-repo/actions page, to see the CI Pipeline running!\n\n| Develop your package's **Source Code** (`business logic`) inside `src/my_great_python_package` dir :)\n| Develop your package's **Test Suite** (ie `unit-tests`, `integration tests`) inside `tests` dir :-)\n\nRead the Documentation's `Use Cases`_ section for more on how to leverage your generated Python Package features.\n\n\nNext Steps\n----------\n\nTo prepare for an Open Source Project Development Lifecycle, you should visit the following websites:\n\n* PyPI, test.pypi.org, Dockerhub, and Read the Docs, for setting up Release and Documentation Pipelines\n* github.com/your-account to configure Actions, through the web UI\n* Codecov, Codacy, and Codeclimate, for setting up Automated Code Quality, with CI Pipelines\n* https://www.bestpractices.dev/ for registering your Project for OpenSSF Best Practices Badge\n\n**Happy Developing!**\n\nLicense\n=======\n\n|gh-lic|\n\n* `GNU Affero General Public License v3.0`_\n\n\nFree/Libre and Open Source Software (FLOSS)\n-------------------------------------------\n\n|ossf|\n\n\n\n\n.. URL LINKS\n\n.. _Cookiecutter documentation: https://cookiecutter.readthedocs.io/en/stable/\n\n.. _CI: https://github.com/boromir674/cookiecutter-python-package/actions\n\n.. _tox: https://tox.wiki/en/latest/\n\n.. _pytest: https://docs.pytest.org/en/7.1.x/\n\n.. _build: https://github.com/pypa/build\n\n.. _pypi.org: https://pypi.org/\n\n.. _test.pypi.org: https://test.pypi.org/\n\n.. _mypy: https://mypy.readthedocs.io/en/stable/\n\n.. _Github Actions: https://github.com/boromir674/cookiecutter-python-package/actions\n\n.. _src/cookiecutter_python/: https://github.com/boromir674/cookiecutter-python-package/tree/master/src/cookiecutter_python\n\n.. _Template: https://github.com/boromir674/cookiecutter-python-package/tree/master/src/cookiecutter_python/%7B%7B%20cookiecutter.project_slug%20%7D%7D\n\n.. _Use Cases: https://python-package-generator.readthedocs.io/en/master/contents/30_usage/index.html#new-python-package-use-cases\n\n.. _GNU Affero General Public License v3.0: https://github.com/boromir674/cookiecutter-python-package/blob/master/LICENSE\n\n.. _Ruff: https://docs.astral.sh/ruff/\n\n.. _isort: https://pycqa.github.io/isort/\n\n.. _black: https://black.readthedocs.io/en/stable/\n\n\n\n.. BADGE ALIASES\n\n.. Build Status\n.. Github Actions: Test Workflow Status for specific branch <branch>\n\n.. |build| image:: https://img.shields.io/github/actions/workflow/status/boromir674/cookiecutter-python-package/test.yaml?link=https%3A%2F%2Fgithub.com%2Fboromir674%2Fcookiecutter-python-package%2Factions%2Fworkflows%2Ftest.yaml%3Fquery%3Dbranch%253Amaster\n   :alt: GitHub Workflow Status (with event)\n\n.. build target https://github.com/boromir674/cookiecutter-python-package/actions/workflows/test.yaml?query=branch%3Amaster\n\n\n.. Documentation\n\n.. |docs| image:: https://img.shields.io/readthedocs/python-package-generator/master?logo=readthedocs&logoColor=lightblue\n    :alt: Read the Docs (version)\n    :target: https://python-package-generator.readthedocs.io/en/master/\n\n.. Code Coverage\n\n.. |coverage| image:: https://img.shields.io/codecov/c/github/boromir674/cookiecutter-python-package/master?logo=codecov\n    :alt: Codecov\n    :target: https://app.codecov.io/gh/boromir674/cookiecutter-python-package\n\n.. PyPI\n\n.. |release_version| image:: https://img.shields.io/pypi/v/cookiecutter_python\n    :alt: Production Version\n    :target: https://pypi.org/project/cookiecutter-python/\n\n.. |wheel| image:: https://img.shields.io/pypi/wheel/cookiecutter-python?color=green&label=wheel\n    :alt: PyPI - Wheel\n    :target: https://pypi.org/project/cookiecutter-python\n\n.. |supported_versions| image:: https://img.shields.io/pypi/pyversions/cookiecutter-python?color=blue&label=python&logo=python&logoColor=%23ccccff\n    :alt: Supported Python versions\n    :target: https://pypi.org/project/cookiecutter-python\n\n.. |pypi_stats| image:: https://img.shields.io/pypi/dm/cookiecutter-python?logo=pypi&logoColor=%23849ED9&color=%23849ED9&link=https%3A%2F%2Fpypi.org%2Fproject%2Fcookiecutter-python%2F&link=https%3A%2F%2Fpypistats.org%2Fpackages%2Fcookiecutter-python\n    :alt: PyPI - Downloads\n    :target: https://pypistats.org/packages/cookiecutter-python\n\n.. Github Releases & Tags\n\n.. |commits_since_specific_tag_on_master| image:: https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/v2.4.0/master?color=blue&logo=github\n    :alt: GitHub commits since tagged version (branch)\n    :target: https://github.com/boromir674/cookiecutter-python-package/compare/v2.4.0..master\n\n.. |commits_since_latest_github_release| image:: https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/latest?color=blue&logo=semver&sort=semver\n    :alt: GitHub commits since latest release (by SemVer)\n\n\n.. LICENSE (eg AGPL, MIT)\n.. Github License\n\n.. |gh-lic| image:: https://img.shields.io/github/license/boromir674/cookiecutter-python-package\n    :alt: GitHub\n    :target: https://github.com/boromir674/cookiecutter-python-package/blob/master/LICENSE\n\n\n.. Free/Libre Open Source Software\n.. Open Source Software Best Practices\n\n.. |ossf| image:: https://bestpractices.coreinfrastructure.org/projects/5988/badge\n    :alt: OpenSSF\n    :target: https://bestpractices.coreinfrastructure.org/en/projects/5988\n\n\n.. CODE QUALITY\n\n.. Codacy\n.. Code Quality, Style, Security\n\n.. |codacy| image:: https://app.codacy.com/project/badge/Grade/5be4a55ff1d34b98b491dc05e030f2d7\n    :alt: Codacy\n    :target: https://app.codacy.com/gh/boromir674/cookiecutter-python-package/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=boromir674/cookiecutter-python-package&amp;utm_campaign=Badge_Grade\n\n\n.. Code Climate CI\n.. Code maintainability & Technical Debt\n\n.. |maintainability| image:: https://api.codeclimate.com/v1/badges/1d347d7dfaa134fd944e/maintainability\n   :alt: Maintainability\n   :target: https://codeclimate.com/github/boromir674/cookiecutter-python-package/\n\n.. |tech-debt| image:: https://img.shields.io/codeclimate/tech-debt/boromir674/cookiecutter-python-package\n    :alt: Code Climate technical debt\n    :target: https://codeclimate.com/github/boromir674/cookiecutter-python-package/\n\n.. Ruff linter for Fast Python Linting\n\n.. |ruff| image:: https://img.shields.io/badge/code%20style-ruff-000000.svg\n    :alt: Ruff\n    :target: https://docs.astral.sh/ruff/\n\n.. Code Style with Black\n\n.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n    :alt: Black\n    :target: https://github.com/psf/black\n\n",
    "bugtrack_url": null,
    "license": "AGPL-3.0-only",
    "summary": "1-click Generator of Python Project, from Template with streamlined \"DevOps\" using a powerful CI/CD Pipeline.",
    "version": "2.4.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/boromir674/cookiecutter-python-package/issues",
        "CI: Github Actions": "https://github.com/boromir674/cookiecutter-python-package/actions",
        "Changelog": "https://github.com/boromir674/cookiecutter-python-package/blob/master/CHANGELOG.rst",
        "Code of Conduct": "https://github.com/boromir674/cookiecutter-python-package/blob/master/CONTRIBUTING.rst",
        "Documentation": "https://python-package-generator.readthedocs.io/",
        "Homepage": "https://github.com/boromir674/cookiecutter-python-package",
        "Repository": "https://github.com/boromir674/cookiecutter-python-package",
        "Source Code": "https://github.com/boromir674/cookiecutter-python-package"
    },
    "split_keywords": [
        "python package generator",
        "python package template",
        "cookiecutter",
        "python package",
        "automation"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2e8db073cfd244213bcd2f279a407705fc42e441651a5f8cf49915aebbeb5a37",
                "md5": "87920dcf98297d66ec95072572d56c3f",
                "sha256": "0aa153a5a245c84a55ab15aa1cedbdee3de33a454d92bdda6c10627d50c5e74e"
            },
            "downloads": -1,
            "filename": "cookiecutter_python-2.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "87920dcf98297d66ec95072572d56c3f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7,<3.13",
            "size": 205692,
            "upload_time": "2024-03-14T14:23:16",
            "upload_time_iso_8601": "2024-03-14T14:23:16.454690Z",
            "url": "https://files.pythonhosted.org/packages/2e/8d/b073cfd244213bcd2f279a407705fc42e441651a5f8cf49915aebbeb5a37/cookiecutter_python-2.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2e436f8f9f0c966c1e6992b5ea99a56f985ce9dd713db8b193bec756851bbece",
                "md5": "84eec4e1b123f4926558815731e4b10c",
                "sha256": "62ab967a05f039bf7e14510c73a89d8158a1783ca4d19b89217370bcb30dc55f"
            },
            "downloads": -1,
            "filename": "cookiecutter_python-2.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "84eec4e1b123f4926558815731e4b10c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7,<3.13",
            "size": 396923,
            "upload_time": "2024-03-14T14:23:22",
            "upload_time_iso_8601": "2024-03-14T14:23:22.572649Z",
            "url": "https://files.pythonhosted.org/packages/2e/43/6f8f9f0c966c1e6992b5ea99a56f985ce9dd713db8b193bec756851bbece/cookiecutter_python-2.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-14 14:23:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "boromir674",
    "github_project": "cookiecutter-python-package",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "tox": true,
    "lcname": "cookiecutter-python"
}
        
Elapsed time: 0.34470s