Skip to content
Open
Show file tree
Hide file tree
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
40 changes: 7 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!--
SPDX-FileCopyrightText: 2021 - 2023 StorPool <[email protected]>
SPDX-FileCopyrightText: 2021 - 2025 StorPool <[email protected]>
SPDX-License-Identifier: BSD-2-Clause
-->

Expand All @@ -10,39 +10,13 @@ build and QA environment, as well as the first step of installations on
end-user systems. It examines several files and tries to determine what
distribution and what version it is running on.

## Basic command-line usage
Detailed information about the library is available at StorPool's
knowledge base:

- `sp_variant detect` - identify the current Linux distribution
- `sp_variant show current` - show JSON data about the current distribution
- `sp_variant show all` - show JSON data about all supported distributions
- `sp_variant show NAME` - show JSON data about a specific distribution
- `sp_variant command list` - show a list of distribution-specific commands
- `sp_variant command run category.item [arg...]` - run
a distribution-specific command
- `sp_variant repo add` - add the Apt or Yum repository definitions for
the StorPool package repository
- [Basic command-line usage](https://kb.storpool.com/reference/sp-variant/sp-variant.html)
- [Python API](https://kb.storpool.com/reference/sp-variant/sp-variant_api.html)
- [Rust API](https://crates.io/crates/sp-variant)

## Basic Python API

The `sp_variant.variant` module exports several constants and functions,
among them:

- `detect_variant()` - return an object describing the detected distribution
- `get_variant()` - get an object describing the specified distribution
- `get_by_alias()` - same, but specify the StorPool builder alias for
the distribution
- `get_all_variants()` - get objects describing all supported distributions
- `command_run()` - run a distribution-specific command

## Basic Rust API

The `sp-variant` crate exports several constants and functions, among them:

- `build_variants()` - return information about all supported variants
- `detect()` - get an object describing the detected distribution
- `get_from()` - get an object describing the specified distribution
- `get_by_alias_from()` - same, but specify the StorPool builder alias for
the distribution

For more information, as well as for suggestions and problem reports, please
contact [the StorPool support team](mailto:[email protected]).
contact the [StorPool support team](mailto:[email protected]).
14 changes: 0 additions & 14 deletions docs/api.md

This file was deleted.

Loading