Skip to content

doc: document host OS and Python support matrix #520

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
blackboxsw wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc: document host OS and Python support matrix #520

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,13 @@ cd pycloudlib
uv sync
```

## Supported platforms

pycloudlib runs on **Linux only**, tested on Ubuntu 24.04 LTS (Python 3.12) and
Ubuntu 26.04 LTS (Python 3.14). See the
[supported platforms](https://pycloudlib.readthedocs.io/en/latest/supported_platforms.html)
documentation for the full support matrix and policy details.

## Usage

The library exports each cloud with a standard set of functions for operating on instances, snapshots, and images. There are also cloud specific operations that allow additional operations.
Expand Down
2 changes: 1 addition & 1 deletion VERSION
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1!11.1.2
1!12.0.1
1 change: 1 addition & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ use the pycloudlib-devs@lists.launchpad.net list.
ssh_keys
images
resource_cleanup
supported_platforms

.. toctree::
:hidden:
Expand Down
35 changes: 35 additions & 0 deletions docs/supported_platforms.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Supported platforms

This page documents the operating systems and Python versions that pycloudlib
is supported and tested on.

## Host operating system

pycloudlib runs on **Linux only**.

### Support matrix

The version of python supported will track the versions of python included in the [two most-recent Ubuntu LTS releases](https://ubuntu.com/about/release-cycle).

The current Host Operating system and python support matrix represets the tested host environments:

| Host OS | Native Python | CI runner | Tox env |
|---------------------|---------------|------------------|----------|
| Ubuntu 24.04 LTS | 3.12 | `ubuntu-24.04` | `py312` |
| Ubuntu 26.04 LTS | 3.14 | `ubuntu-26.04`* | `py314`* |

### Notes

* Other Linux distributions *may* work but are not tested. Bugs reported
against untested distributions will be considered on a best-effort basis.
* Windows and macOS are not supported.
* Integration tests have Linux-only hard requirements that prevent the host
OS matrix from extending beyond Linux:
* the **LXD snap** (installed via the `canonical/setup-lxd` action in
`.github/workflows/ci.yaml`), and
* the **`distro-info`** apt package.

## Python versions

pycloudlib's documented and tested minimum Python version is **3.12**, the
native Python of the oldest in-scope Ubuntu LTS release (24.04).
Loading