Skip to main content

Frequenz Repository Configuration

Build Status PyPI Package Docs

Introduction

This is a highly opinionated set of tools and configurations to set up a Python repository for Frequenz projects.

It offers:

  • Cookiecutter templates for scaffolding new projects
  • Trivial build of noxfile.py with some predefined sessions that include all common checks.
  • Tools to build protobuf/grpc files as Python, including type information.

Supported Platforms

The following platforms are officially supported (tested):

  • Python: 3.11
  • Operating System: Ubuntu Linux 20.04
  • Architectures: amd64, arm64

Quick Example

To start a new project, you should first install Cookiecutter. It is normally available in any Linux distribution, but some have a very old version (for example, Ubuntu/Debian). You can check which version your distro has on Repology. You need at least version 2.4.0. To ensure you get an up-to-date version, you can always use pip and install it in a venv:

$ python -m venv cookiecutter
$ cd cookiecutter
$ . bin/activate
(venv) $ pip install cookiecutter
Collecting cookiecutter
...

Then simply run Cookiecutter where you want to create the new project. A new directory will be created with the generated project name. For example:

cd ~/devel
cookiecutter gh:frequenz-floss/frequenz-repo-config-python --directory=cookiecutter

This command will prompt you for the project type, name, and other configuration options, and it will generate the entire project for you.

It is recommended to use a released version, you can do that by adding the option --checkout <version> to the command above. You can check which is the latest version here.

After completing the project and fixing the TODOs, you can either amend the previous commit using git commit --amend or create a new commit for the changes using git commit.

Documentation

For more detailed documentation, please check the project's website.

Contributing

If you want to know how to build this project and contribute to it, please refer to the Contributing Guide.

Metadata

Release files for frequenz-repo-config 0.19.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for frequenz-repo-config 0.19.0
File Size Uploaded Provenance
frequenz_repo_config-0.19.0.tar.gz 49.1 kB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for frequenz-repo-config 0.19.0
File Interpreter ABI Platform
frequenz_repo_config-0.19.0-py3-none-any.whl Python 3 none any Details

Total release size: 94.6 kB

Release files / frequenz_repo_config-0.19.0.tar.gz

Download URL frequenz_repo_config-0.19.0.tar.gz
Size 49.1 kB
Tags Source
SHA-256 checksum
How to use checksums
354d1dc2b82889d7081cc1db084f3f2ab40e2f876b5c2ac64278bf144b77636d
BLAKE2b-256 checksum
How to use checksums
47114767e0614fc80b493a6949bf29d07254a60a5a45b015595872e9df7bf777
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 26, 2026.

Transparency log

Release files / frequenz_repo_config-0.19.0-py3-none-any.whl

Download URL frequenz_repo_config-0.19.0-py3-none-any.whl
Size 45.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7f961b9fc4298391e47ca492ebb2634585da01b362fb02b9be6e6bac5044f49f
BLAKE2b-256 checksum
How to use checksums
317833c647b8152b25a0cfa599a4128e94af4e29f0bb70781a73adb936e5024e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 26, 2026.

Transparency log

Security for frequenz-repo-config 0.19.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for frequenz_repo_config-0.19.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 26, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.19.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page