ghflowgen

Overview

ghflowgen is an experimental Python library that provides functionalities to manage GitHub action workflows.

• Motivation
• Documentation
• Installation
• Contributing
• API stability
• License

Documentation

• latest (stable): documentation from the latest stable release.
• main (unstable): documentation associated to the main branch of the repo. This documentation may contain a lot of work-in-progress/outdated/missing parts.

Installation

We highly recommend installing a virtual environment. You can install ghflowgen using either pip (standard Python installer) or uv (a faster, modern alternative).

Using pip

The following command will automatically download and install the latest version of the package from PyPI , along with all required dependencies.

pip install ghflowgen

To make the package as slim as possible, only the minimal packages required to use ghflowgen are installed. To include all the dependencies, you can use the following command:

pip install ghflowgen[all]

Using uv

The following command will automatically download and install the latest version of the package from PyPI , along with all required dependencies.

uv pip install ghflowgen

To make the package as slim as possible, only the minimal packages required to use ghflowgen are installed. To include all the dependencies, you can use the following command:

uv pip install ghflowgen[all]

Dependencies

Please check the get started page to see how to install only some specific dependencies or other alternatives to install the library. The following is the corresponding ghflowgen versions and tested dependencies.

^* indicates an optional dependency

Contributing

Please check the instructions in CONTRIBUTING.md.

Suggestions and Communication

Everyone is welcome to contribute to the community. If you have any questions or suggestions, you can submit Github Issues. We will reply to you as soon as possible. Thank you very much.

API stability

:warning: While ghflowgen is in development stage, no API is guaranteed to be stable from one release to the next. In fact, it is very likely that the API will change multiple times before a stable 1.0.0 release. In practice, this means that upgrading ghflowgen to a new version will possibly break any code that was using the old version of ghflowgen.

License

ghflowgen is licensed under BSD 3-Clause "New" or "Revised" license available in LICENSE file.