Frequenz repository setup tools and common configuration
Project description
Frequenz Repository Configuration
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 TODO
s, 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for frequenz-repo-config-0.10.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 99d6b79ff0bca710ebb916fa5d309d15a241f43227b9d63bba919af48c78ddc1 |
|
MD5 | 8602500299013409e27139dff7085fc7 |
|
BLAKE2b-256 | c6187ef7219550da35b92b40e17f0bdb7c27421736283ba4a3b65a4c0d871138 |
Hashes for frequenz_repo_config-0.10.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | de19830e5d9656b1df4eb071fb5a3776f6ed5f956c0249381ed34d0051b713ee |
|
MD5 | ab07a0c6fb97a0c57c1d1f35e259b810 |
|
BLAKE2b-256 | 7a2787ea44f57728a9947b4efdf320704b07795630ae9e21431edd3b13fc5dba |