Skip to main content

Frequenz repository setup tools and common configuration

Project description

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 details


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.11.0.tar.gz (37.5 kB view details)

Uploaded Source

Built Distribution

frequenz_repo_config-0.11.0-py3-none-any.whl (39.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: frequenz_repo_config-0.11.0.tar.gz
  • Upload date:
  • Size: 37.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for frequenz_repo_config-0.11.0.tar.gz
Algorithm Hash digest
SHA256 511e800dae230c5d0c69d359a4795140820fde2d62b502d1d69e09feb61e3cd7
MD5 c53d11a8ae655f0545e3c1811b821ef5
BLAKE2b-256 251019f91ae413fb7b6e279eb5c7f0883a441c98da0186a51c478b49bc81870d

See more details on using hashes here.

Provenance

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

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

Attestations:

File details

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

File metadata

File hashes

Hashes for frequenz_repo_config-0.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1403ca1fdd1174f801e808467fd4a62849a830b00496d69c3f436c99af473f7a
MD5 5afb5438b8f58b3d17db583317bbf970
BLAKE2b-256 4557b56c20e78b2185901fab297227bde9d2dae35d6de669a6859e96015103a0

See more details on using hashes here.

Provenance

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

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

Attestations:

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page