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.

Project links

Data verified by PyPI on Aug 12, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.19.0)

Owner

PyPI data
Data sourced directly from PyPI's database.

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for tiyashbasu from gravatar.com tiyashbasu

Credits

Author: Frequenz Energy-as-a-Service GmbH

GitHub Statistics

Data verified by PyPI on Aug 12, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

MIT
View SPDX License List

Requires

Python <4, >=3.11

Provides Extra

actor api app lib model extra-lint-examples dev-flake8 dev-formatting dev-mkdocs dev-mypy dev-noxfile dev-pylint dev-pytest dev

Tags

config frequenz grpc lib library mkdocs nox project protobuf python repo-config repository setuptools tool

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

frequenz_repo_config-0.18.3.tar.gz (47.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

frequenz_repo_config-0.18.3-py3-none-any.whl (45.4 kB view details)

Uploaded Python 3

File details

Details for the file frequenz_repo_config-0.18.3.tar.gz.

File metadata

  • Download URL: frequenz_repo_config-0.18.3.tar.gz
  • Upload date:
  • Size: 47.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for frequenz_repo_config-0.18.3.tar.gz
Algorithm Hash digest
SHA256 6809980d68dd19f825846cfff3e43036bfff0f7a8fb137088efc8b1143ffad91
MD5 b42e58d928f68ae4d43b9e0ace841437
BLAKE2b-256 3364b1a3470afba13ee0e0c0b773fea705a9e61001bfbafe1c86d2eb82135f33

See more details on using hashes here.

Provenance

The following attestation bundles were made for frequenz_repo_config-0.18.3.tar.gz:

Publisher: ci.yaml on frequenz-floss/frequenz-repo-config-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file frequenz_repo_config-0.18.3-py3-none-any.whl.

File metadata

File hashes

Hashes for frequenz_repo_config-0.18.3-py3-none-any.whl
Algorithm Hash digest
SHA256 44a79e1ce53df710f60d367653a5d8c79883cecfc5b94fb8cccc7e1199ea2bd0
MD5 b206413e2231c92ce508801c19d630e4
BLAKE2b-256 25bda1b87ebec0ce34c314ab1d0e58bea381cef1b4a1423eaa690f82ac613578

See more details on using hashes here.

Provenance

The following attestation bundles were made for frequenz_repo_config-0.18.3-py3-none-any.whl:

Publisher: ci.yaml on frequenz-floss/frequenz-repo-config-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.19.0

2 files

This release

0.18.3 This release

2 files

0.18.2

2 files

0.18.0

2 files

0.17.0

2 files

0.16.0

2 files

0.15.1

2 files

0.14.0

2 files

0.13.8

2 files

0.13.7

2 files

0.13.6

2 files

0.13.5

2 files

0.13.4

2 files

0.13.3

2 files

0.13.2

2 files

0.13.1

2 files

0.13.0

2 files

0.12.3

2 files

0.12.2

2 files

0.12.1

2 files

0.12.0

2 files

0.11.0

2 files

Pre-release

0.11.0rc1

2 files

0.10.0

2 files

0.9.2

2 files

0.9.1

2 files

0.9.0

2 files

0.8.0

2 files

0.7.5

2 files

0.7.4

2 files

0.7.3

2 files

0.7.2

2 files

0.7.1

2 files

0.7.0

2 files

Pre-release

0.7.0rc1

2 files

0.6.2

2 files

0.6.1

2 files

0.6.0

2 files

0.5.2

2 files

0.5.1

2 files

0.5.0

2 files

0.4.0

2 files

0.3.0

2 files

0.2.0

2 files

0.1.0

2 files

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