pytemplates-pypackage 0.0.6

A template for a python package.

Description

A production ready python library template. Features include:

• Metadata and dependency information stored in the pyproject.toml for compatibility with both pip and poetry.
• Flake8, pylint, isort, and pytest configurations compatible with the black autoformatter.
• Pylint settings based on the Google Python Style Guide and adapted for black compatibility.
• Automated linting before each commit using pre-commit, black, and isort.
• Automated testing and coverage reports on every commit and pull request using coverage, pytest-cov, and codecov.io.
• Automated source code documentation using Sphinx and github pages.
• Automated package deployments to PyPI using github actions.

Installation

To install the package using pip:

pip install pytemplates_pypackage

To add the package as a dependency using poetry:

poetry add pytemplates_pypackage

Usage

From a .py file:

import pytemplates_pypackage
print(pytemplates_pypackage.__version__)
pytemplates_pypackage.greet(user="Jacob")

from pytemplates_pypackage import wish_farewell
wish_farewell(user="Jacob")

Developer Setup

Install the package using poetry:

poetry install

Install optional dependencies using the --extras flag:

poetry install --extras={environment}

Environments

test = [
    "pytest",
    "pytest-cov",
]

lint = [
    "black",
    "isort",
    "flake8",
    "pylint",
    "mypy",
    "pre-commit",
]

docs = [
    "Sphinx",
    "sphinx-rtd-theme",
]

# Includes all optional dependencies
dev = [
    "pytest",
    "pytest-cov",
    "black",
    "isort",
    "flake8",
    "pylint",
    "mypy",
    "pre-commit",
    "Sphinx",
    "sphinx-rtd-theme",
    "bump2version",
]

Commands

• make clean - Remove all build, testing, and static documentation files.

• make lint - Run the linting tools. Includes pre-commit hooks, black, isort, flake8, pylint, and mypy.

• make test - Run the tests using pytest.

• make check - Run the lint and test commands, followed by the clean command.

• make gen-docs - Generate Sphinx HTML documentation.

• make docs - Generate Sphinx HTML documentation and serve it to the browser.

• make pre-release - Bump the version and create the release tag.

• make release - Push the release tag and trigger the release pipeline.

Workflows

• lint - Run the linting tools on every push/pull_request to the main branch. Includes pre-commit hooks, black, isort, flake8, pylint, and mypy.

• test - Run the tests on every push/pull_request to the main branch. Writes a coverage report using pytest-cov and uploads it to codecov.io.

• build-and-release - Build a package distribution, create a github release, and publish the distribution to PyPI on every tag creation. Linting and testing steps must pass before the build process can begin. Sphinx documentation is automatically published to the sphinx-docs branch and hosted on github pages.

File Tree

.
├── docs/
├── LICENSE
├── Makefile
├── poetry.lock
├── pyproject.toml
├── README.md
├── src
│   └── pytemplates_pypackage
│       ├── core
│       │   ├── __init__.py
│       │   ├── module1.py
│       │   └── module2.py
│       ├── __init__.py
│       └── __version__.py
└── tests
    ├── __init__.py
    ├── test_module1.py
    └── test_module2.py