Awesome

ARCHIVED, pypackage

I no longer with to maintain this cookiecutter, please see br3ndonland/template-python's template. While not a cookiecutter at the time of this writing, it has the tooling I was going for :)

The Basic Idea

This is a template module collecting many utilities I have liked from other projects, to serve as a personal reference.

• https://github.com/tiangolo/pydantic-sqlalchemy/
• https://github.com/cookiecutter/cookiecutter

Getting started with this template

pip install --user cookiecutter

$ cookiecutter https://github.com/iancleary/pypackage
# For the sake of brevity, repos on GitHub can just use the 'gh' prefix
$ cookiecutter gh:iancleary/pypackage

Features

• Poetry (virtual environment and publish to PyPi, all with one tool)
• black (linting/formatter)
• autoflake (removing unused packages)
• isort (dependency organization)
• mypy (static type checking)
• pytest (including test coverage)
• pre-commit (hooks on commit)
• GitHub Actions for CI/CD
• mkdocs for documentation (with material theme)

Only Python 3.6+ is supported as required by the black, pydantic packages

Publishing to Pypi

Poetry's documentation

Note that it is recommended to use API tokens when uploading packages to PyPI.

Once you have created a new token, you can tell Poetry to use it:

https://python-poetry.org/docs/repositories/#configuring-credentials

We do this using GitHub Actions' Workflows and Repository Secrets!

Repo Secrets

Go to your repo settings and add a PYPI_TOKEN environment variable:

Inspect the GitHub Actions Publish Workflows

Within the cookiecutter project!

name: Publish

on:
  release:
    types:
      - created

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      ...
      ...
      ...
      - name: Publish
        env:
          PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
        run: |
          poetry config pypi-token.pypi $PYPI_TOKEN
          bash scripts/publish.sh

That's it!

When you make a release on GitHub, the publish workflow will run and deploy to PyPi! 🚀🎉😎

The publish.yml GitHub Workflow for this repo intentionally only builds the package. The limited purpose is to demonstrate the publish workflow trigger and allow you to inspect the file's similarity to the equivalent file within the cookiecutter.

Contributing Guide

Welcome! 😊👋

Please see the Contributing Guide.