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.0.tar.gz (37.4 kB view hashes)

Uploaded Source

Built Distribution

cookiecutter_python-0.6.0-py3-none-any.whl (36.2 kB view hashes)

Uploaded Python 3

Supported by

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