Skip to content

Latest commit

 

History

History
106 lines (86 loc) · 2.99 KB

README.md

File metadata and controls

106 lines (86 loc) · 2.99 KB
Raw

PyPI Cookiecutter

A cookiecutter project to generate projects slated to become PyPI packages. The generated CI ensures that the package is ready to deploy to both the test.pypi.org and the regular pypi.org indexes.

The project is generated using some inputs, it is recommended to generate a project from a virtualenvironment to avoid having Cookiecutter installed globally.

Note: The template will generate a containing folder for the project, if you execute this from within a folder it will be nested.

Usage

To create a project run the following:

pip install -r requirements.txt
cd <your parent folder location>
cookecutter https://github.com/mattdood/pypi-cookiecutter.git

Initial setup

The following GitHub secrets will need to be added in order to release the PyPI packages without the CI failing:

  • TEST_PYPI_API_TOKEN
  • PYPI_API_TOKEN

These can be generated using the following links:

Releasing builds

To release builds for the project we use a combination of tagging and changes to setup.py.

For any releases to test.pypi.org use a change to the version="..." inside of setup.py. Once a PR is merged into the main project the test release will be updated.

Any prod releases to pypi.org require a tagged version number. This should be done locally by running the following:

git checkout master
git pull master
git tag v<version-number-here>
git push origin v<version-number-here>

Rollbacks of versions

To roll a version back we need to delete the tagged release from the prod PyPI, then delete the GitHub tag.

git tag -d v<version-number-here>
git push origin :v<version-number-here>

Generated content

  • GitHub CI for PyPI releases, tests, and linting
    • Note: The project requires GitHub secrets to be added for PyPI access.
  • Readme with badges and project usage steps
  • MIT license
  • Requirements files for local dev and regular installation
  • Pytest setup (conftest and tests directory)
  • Pre-Commit setup with flake8, isort, etc. for linting
  • setup.py and pyproject.toml for PyPI package release
  • A comprehensive .gitignore

Example run

cookiecutter https://github.com/mattdood/pypi-cookiecutter

directory_name [sample]:
project_name [sample]:
project_slug [sample
author_name [Matthew Wimberly]:
author_email [[email protected]]:
description [A sample project build.]:
github_username [mattdood]:
repository_name [sample]:
min_python_version [3.6]:


cd sample/
tree .
    .
    ├── assets
    ├── conftest.py
    ├── LICENSE
    ├── pyproject.toml
    ├── README.md
    ├── requirements-dev.txt
    ├── requirements.txt
    ├── sample
    │   └── __init__.py
    ├── setup.py
    └── test
        └── __init__.py

    3 directories, 9 files