Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/frequenz-floss/frequenz-repo-config-python
Frequenz repository setup tools and common configuration for Python
https://github.com/frequenz-floss/frequenz-repo-config-python
config frequenz grpc lib library mkdocs nox project protobuf python repo-config repository setuptools tool
Last synced: 2 months ago
JSON representation
Frequenz repository setup tools and common configuration for Python
- Host: GitHub
- URL: https://github.com/frequenz-floss/frequenz-repo-config-python
- Owner: frequenz-floss
- License: mit
- Created: 2023-03-31T13:33:11.000Z (almost 2 years ago)
- Default Branch: v0.x.x
- Last Pushed: 2024-11-04T09:27:47.000Z (3 months ago)
- Last Synced: 2024-11-16T17:44:56.414Z (3 months ago)
- Topics: config, frequenz, grpc, lib, library, mkdocs, nox, project, protobuf, python, repo-config, repository, setuptools, tool
- Language: Python
- Homepage: https://frequenz-floss.github.io/frequenz-repo-config-python/
- Size: 5.24 MB
- Stars: 4
- Watchers: 1
- Forks: 7
- Open Issues: 72
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Frequenz Repository Configuration
[](https://github.com/frequenz-floss/frequenz-repo-config-python/actions/workflows/ci.yaml)
[](https://pypi.org/project/frequenz-repo-config/)
[](https://frequenz-floss.github.io/frequenz-repo-config-python/)
## Introduction
This is a highly opinionated set of tools and configurations to set up a Python
repository for [Frequenz](https://frequenz.com) 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](https://cookiecutter.readthedocs.io/en/stable/installation.html).
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](https://repology.org/project/cookiecutter/versions). 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`:
```console
$ 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:
```sh
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 ` to the command above. You can check which is the
latest version
[here](https://github.com/frequenz-floss/frequenz-repo-config-python/releases/latest).
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](https://frequenz-floss.github.io/frequenz-repo-config-python/).
## Contributing
If you want to know how to build this project and contribute to it, please
refer to the [Contributing Guide](CONTRIBUTING.md).
[Cookiecutter]: https://cookiecutter.readthedocs.io/en/stable