https://github.com/gardenlinux/python-gardenlinux-lib
Contains tools to work with the features directory of gardenlinux, for example deducting dependencies from feature sets or validating cnames
https://github.com/gardenlinux/python-gardenlinux-lib
Last synced: 29 days ago
JSON representation
Contains tools to work with the features directory of gardenlinux, for example deducting dependencies from feature sets or validating cnames
- Host: GitHub
- URL: https://github.com/gardenlinux/python-gardenlinux-lib
- Owner: gardenlinux
- Created: 2024-08-08T05:33:12.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2026-05-20T12:17:33.000Z (about 1 month ago)
- Last Synced: 2026-05-20T16:53:05.733Z (about 1 month ago)
- Language: Python
- Homepage:
- Size: 6.57 MB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Garden Linux Python Library
Python tooling to work with [Garden Linux](https://github.com/gardenlinux/gardenlinux) features, flavors, OCI artifacts, repositories, and releases.
It is primarily targeted at Garden Linux developers and CI pipelines rather than end users.
The library follows the intent of [Semantic Versioning](https://semver.org) for its public APIs.
### Features
- **Feature management**: parse, filter, and work with Garden Linux feature sets
- **Flavor processing**: parse `flavors.yaml` and generate flavor combinations
- **Repository utilities**: compare APT repositories and query package versions
- **OCI operations**: push OCI artifacts and manifests to container registries
- **S3 integration**: upload/download artifacts from S3 buckets
- **GitHub integration**: create and manage GitHub releases
## Documentation
Full documentation is available at the **Garden Linux Python Library Documentation** site:
[https://gardenlinux.github.io/python-gardenlinux-lib/](https://gardenlinux.github.io/python-gardenlinux-lib/)
The docs include:
- **Command-Line Interface**: `gl-features-*`, `gl-flavors-*`, `gl-oci`, `gl-s3`, `gl-gh-release`
- **API Reference**: modules, classes, and functions (e.g. `Parser`, `CName`, `Container`, `Repository`)
- **Release documentation**: versioning and release process
## Installation
### Using `poetry` (from Git)
Add the library as a dependency in your `pyproject.toml`:
```toml
[tool.poetry.dependencies]
gardenlinux = { git = "https://github.com/gardenlinux/python-gardenlinux-lib", rev = "0.10.5" }
```
Then install:
```bash
poetry install
```
### Local development setup
```bash
git clone https://github.com/gardenlinux/python-gardenlinux-lib.git
cd python-gardenlinux-lib
python -m venv venv
source venv/bin/activate
poetry install
```
## Quickstart
### Example: list features for a given `cname`
```python
from gardenlinux.features import Parser
cname = "aws-gardener_prod"
feature_list = Parser().filter_as_list(cname)
print(f"features of {cname}:")
for feature in feature_list:
print(feature)
```
For more examples and for all CLI tools, see the **Command-Line Interface** and **API Reference** sections in the docs:
[https://gardenlinux.github.io/python-gardenlinux-lib/](https://gardenlinux.github.io/python-gardenlinux-lib/)
