mihaibojin / template-python-package-2024

A template for publishing Python Packages [2024 edition]

Python Package template - 2024

Use this repo as a template for starting multi-package Python projects.

Quickstart

The project is published to https://pypi.org/project/template-python-package-2024/. Install it via:

pip install template-python-package-2024

# or alternatively, directly from git
pip install "git+https://github.com/MihaiBojin/template-python-package-2024@main"

Publishing to PyPI

GitHub-based version publishing

The simplest way to publish a new version (if you have committer rights) is to tag a commit and push it to the repo:

# At a certain commit, ideally after merging a PR to main
git tag v0.1.x
git push origin v0.1.x

A GitHub Action will run, build the library and publish it to PyPI.

Manual

These steps can also be performed locally. For these commands to work, you will need to export two environment variables:

export TESTPYPI_PASSWORD=... # token for https://test.pypi.org/legacy/
export PYPI_PASSWORD=... # token for https://upload.pypi.org/legacy/

First, publish to the test repo and inspect the package:

make publish-test

If correct, distribute the wheel to the PyPI index:

make publish

Verify the distributed code

make publish-verify

Building a Docker image

Build an image with:

make docker

and run it with

make docker-run
# or
make docker-run ARGS="--arg1 --arg2 --etc"

template-python-package-2024's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

devcontainer

.devcontainer/devcontainer.json

• ghcr.io/devcontainers/features/docker-in-docker 2

dockerfile

.devcontainer/Dockerfile

Dockerfile

• python 3.12-slim

github-actions

.github/workflows/docker-publish.yml

• actions/checkout v4
• actions/setup-python v5
• actions/checkout v4
• docker/login-action v3
• actions/setup-python v5

.github/workflows/python-publish.yml

• actions/checkout v4
• actions/setup-python v5
• actions/checkout v4
• actions/setup-python v5

.github/workflows/python-tests.yml

• actions/checkout v4
• actions/setup-python v5

pep621

pyproject.toml

pip_requirements

requirements-dev.txt

• build == 1.2.1
• pre-commit ==3.8.0
• pytest ==8.3.2
• toml == 0.10.2
• twine ==5.1.1
• wheel ==0.44.0
• wheel-inspect == 1.7.1

---

• Check this box to trigger a request for Renovate to run again on this repository