Skip to main content

Yet another modern Python Package (pypi) with emphasis in CI/CD and automation

Project description

Cookiecutter Python Package

Python Package (pypi) Cookiecutter, with emphasis on CI/CD and automation.

GitHub Workflow Status (branch) Production Version PyPI - Wheel Supported Python versions GitHub commits since tagged version (branch) GitHub commits since latest release (by SemVer)

Features

  • Python Package Project generation

  • CI pipeline to test against multiple Python versions and Platforms

  • One-line commands for DevOps activities such as ‘package’, ‘build’, ‘deploy’

  • Test Suite, using Pytest

Prerequisites

You need to have Cookiecutter installed. Check the Cookiecutter documentation pages for more on Cookiecutter.

Usage

Simply, get (clone) the code and generate a Project based on the (downloaded) template.

Open a console/terminal and run:

git clone git@github.com:boromir674/cookiecutter-python-package.git

cookiecutter cookiecutter-python-package/src/cookiecutter_python

This will generate a new Python Package Project (in the currect dir), using the template from github. It shall prompt you to enter the necessary initial information to generate the project in a typical cookiecutter fashion.

Modifying the Template

You can always adjust the template to your needs, before generating a new Project.

Open a console/terminal and run:

git clone git@github.com:boromir674/cookiecutter-python-package.git
cd cookiecutter-python-package

Now, you should be inside the cookiecutter-python-package repository (directory) and the actual Template, that you can modify, is inside the src/cookiecutter_python sub directory.

After, finishing the modifications you can run something like:

cookiecutter src/cookiecutter_python --output-dir <your-new-project-dir>

License

  • Free software: Affero GNU General Public License v3.0

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cookiecutter_python-0.6.1.tar.gz (37.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cookiecutter_python-0.6.1-py3-none-any.whl (36.2 kB view details)

Uploaded Python 3

File details

Details for the file cookiecutter_python-0.6.1.tar.gz.

File metadata

  • Download URL: cookiecutter_python-0.6.1.tar.gz
  • Upload date:
  • Size: 37.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.0 importlib_metadata/4.11.3 packaging/21.3 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.64.0 CPython/3.8.10

File hashes

Hashes for cookiecutter_python-0.6.1.tar.gz
Algorithm Hash digest
SHA256 e97a337d943a42eee6eb7fcbc0824165867555f0b50cfe1e9be874d2ddfa0363
MD5 8d3b163357883e662850b35be543584e
BLAKE2b-256 548ab39b58c2f0df3b44690a4cac16e9b22c2cfc8fc69b94599ba2af4cf98b7f

See more details on using hashes here.

File details

Details for the file cookiecutter_python-0.6.1-py3-none-any.whl.

File metadata

  • Download URL: cookiecutter_python-0.6.1-py3-none-any.whl
  • Upload date:
  • Size: 36.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.0 importlib_metadata/4.11.3 packaging/21.3 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.64.0 CPython/3.8.10

File hashes

Hashes for cookiecutter_python-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6b8f481f32bd28ebbc2f4f7f0016748f4c79fbaaeddbcd6ae4dbf8d77d563082
MD5 a571ca8b952771700899e23fdeb91b49
BLAKE2b-256 8ff6ad92bc1f13d13b9ba6483849cd366fc43e2b584019f690d98bdb110c03bf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page