Skip to content
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 14 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
## Garden Linux Python Library

![poetry build](https://github.com/gardenlinux/parse_features_lib/actions/workflows/build.yml/badge.svg)
![Black Lint](https://github.com/gardenlinux/parse_features_lib/actions/workflows/black.yml/badge.svg)
![Test](https://github.com/gardenlinux/parse_features_lib/actions/workflows/pytests.yml/badge.svg)
![security check](https://github.com/gardenlinux/parse_features_lib/actions/workflows/bandit.yml/badge.svg)

## 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.
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.
The library follows the intent of [Semantic Versioning](https://semver.org) for
its public APIs.

### Features

Expand All @@ -21,14 +24,11 @@ The library follows the intent of [Semantic Versioning](https://semver.org) for

## 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:
You can find our full documentation for this python library on our
[Documentation Hub](https://gardenlinux-docs.netlify.app/reference/supporting_tools/python-gardenlinux-lib.html).

- **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
For a detailed API documentation, check
[gardenlinux.github.io/python-gardenlinux-lib/api.html](https://gardenlinux.github.io/python-gardenlinux-lib/)

## Installation

Expand Down Expand Up @@ -72,7 +72,8 @@ for feature in feature_list:
print(feature)
```
Comment on lines 33 to 73
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's remove the "installation" section and directly link the docs that explain it.


For more examples and for all CLI tools, see the **Command-Line Interface** and **API Reference** sections in the docs:
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/)
Comment on lines +75 to 77
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Properly link to docs.


<p align="center">
Expand Down
Loading