sgraaf / cookiecutter-python-package

A cookiecutter template for creating a new Python package

Machine Learning 🤖 and Data Science 🧮 Engineer with a focus on NLP. Full-stack Pythonista 🐍. He/him.

cookiecutter-python-package's Issues

Add human-readable prompts

Add more verbose, human-readable prompts using the __prompts__ key, as per https://cookiecutter.readthedocs.io/en/stable/advanced/human_readable_prompts.html

Add Dependabot

Add Dependabot to perform automatic version updated for GitHub Actions, see https://docs.github.com/en/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot.

Add support for Python 3.12

Python 3.12 was released yesterday. As such, we should addsupport for it in the next major release.

Add tox / nox to automate testing, linting, etc.

Add tox or nox for automating testing, linting, type checking, building documentation, etc.

Drop support for Python 3.7

Python 3.7 has gone end-of-life (EOL) 2 months ago. As such, we should drop support for it in the next major release.

Add typehint support for `sphinx.ext.autodoc`

The idea here is to define type hints only in the class / function signature and leave them out of the docstring.

I first noticed that structlog has a nice API reference with type annotations, without including them in the docstrings (only in the signature). For this, they use the (undocumented ?!) sphinx.ext.autodoc.typehints Sphinx extension.

Alternatives exist, like sphinx-autodoc-typehints, which gives the following example:

This allows you to use type hints in a very natural fashion, allowing you to migrate from this:

def format_unit(value, unit):
    """
    Formats the given value as a human readable string using the given units.

    :param float|int value: a numeric value
    :param str unit: the unit for the value (kg, m, etc.)
    :rtype: str
    """
    return f"{value} {unit}"

to this:

from typing import Union


def format_unit(value: Union[float, int], unit: str) -> str:
    """
    Formats the given value as a human readable string using the given units.

    :param value: a numeric value
    :param unit: the unit for the value (kg, m, etc.)
    """
    return f"{value} {unit}"

Add options for more licenses

Add options for more licenses. For Python, the most popular OSI licenses are (determined via the GitHub REST API):

1. MIT
2. GNU General Public License v3.0
3. Apache license 2
4. GNU General Public License v2.0
5. BSD 3-clause "New" or "Revised" license
6. GNU Affero General Public License v3.0
7. The Unlicense

The first three licenses are already supported.

Replace `Flake8`, `isort`, `pyupgrade` and `autoflake` with `ruff`

Replace various linters (Flake8, isort, pyupgrade and autoflake) with ruff.