Skip to content

Commit 8e7e5c0

Browse files
docs, README: Update intro, supported Python versions and badges
Signed-off-by: Bernhard Kaindl <[email protected]>
1 parent 9167c4f commit 8e7e5c0

File tree

4 files changed

+38
-24
lines changed

4 files changed

+38
-24
lines changed

README.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,21 @@
1-
# Common XenServer/XCP-ng Python classes
1+
# XenServer Python libs for Dom0
22

3-
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
4-
[![](https://img.shields.io/badge/python-2.7_%7C_3.6_%7C_3.7_%7C_3.8_%7C_3.9_%7C_3.10_%7C_3.11+-blue.svg)](https://www.python.org/downloads/)
3+
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://pre-commit.com)
4+
[![](https://img.shields.io/badge/python-3.6_%7C_3.11_%7C_3.12_%7C_3.13-blue.svg)](https://www.python.org/downloads/)
5+
[![](https://coveralls.io/repos/github/xenserver/python-libs/badge.svg?branch=master)](https://coveralls.io/github/xenserver/python-libs?branch=master)
56
[![codecov](https://codecov.io/gh/xenserver/python-libs/branch/master/graph/badge.svg?token=6WKVLDXJFN)](https://codecov.io/gh/xenserver/python-libs)
6-
[![](https://img.shields.io/badge/License-BSD--2--Cause%20%26%20MIT-brightgreen)](https://github.com/xenserver/python-libs/blob/master/LICENSE)
7-
8-
The `xcp` directory contains the Common XenServer and XCP-ng Python packages.
9-
They are intented for use in XenServer and XCP-ng Dom0 only and deal with logging,
10-
Hardware/PCI, networking, and other Dom0 tasks.
11-
12-
The package name is `python-libs` which is also the `rpm` package name in XenServer.
13-
XCP-ng packages it as [xcp-python-libs](https://github.com/xcp-ng-rpms/xcp-python-libs)
14-
([koji](https://koji.xcp-ng.org/packageinfo?packageID=400)).
7+
[![](https://img.shields.io/badge/License-BSD--2--Clause%20%26%20MIT-brightgreen)](https://github.com/xenserver/python-libs/blob/master/LICENSE)
8+
[![](https://img.shields.io/badge/Sphinx-docs-blue.svg)](https://python-libs.onrender.com/)
9+
10+
The `xcp` directory contains the XenServer Python modules used in Dom0 internally.
11+
They are used in XenServer Dom0 and derivatives to provide them with services around
12+
logging, Hardware-related configuration, network interfaces, and other Dom0 tasks.
13+
The callers of these modules are only other XenServer components residing in Dom0.
14+
A detailed list is in the [Users](#users) section.
15+
The rpm package name in XenServer 8.4 is `python3-xcp-libs`.
16+
XCP-ng packages it currently as
17+
[xcp-python-libs](https://github.com/xcp-ng-rpms/xcp-python-libs)
18+
([koji](https://koji.xcp-ng.org/packageinfo?packageID=400)) instead.
1519

1620
## Test-driven Development (TDD) Model
1721

docs/source/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@
4646
"myst_parser",
4747
]
4848

49+
myst_heading_anchors = 2
4950
templates_path = ["_templates"]
5051
exclude_patterns = []
5152

docs/source/index.rst

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,22 @@
1-
.. python-libs documentation master file, created by
2-
sphinx-quickstart on Tue Aug 26 19:05:28 2025.
3-
You can adapt this file completely to your liking, but it should at least
4-
contain the root `toctree` directive.
1+
.. python-libs documentation master file
52
6-
python-libs documentation
7-
=========================
3+
XenServer Python libs for Dom0
4+
==============================
5+
6+
.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit
7+
:target: https://pre-commit.com/
8+
9+
.. image:: https://coveralls.io/repos/github/xenserver/python-libs/badge.svg?branch=master
10+
:target: https://coveralls.io/github/xenserver/python-libs?branch=master
11+
12+
.. image:: https://codecov.io/gh/xenserver/python-libs/branch/master/graph/badge.svg?token=6WKVLDXJFN
13+
:target: https://codecov.io/gh/xenserver/python-libs/branch/master
14+
15+
.. image:: https://img.shields.io/badge/License-BSD--2--Clause%20%26%20MIT-brightgreen
16+
:target: https://opensource.org/licenses/BSD-2-Clause
17+
18+
.. image:: https://img.shields.io/badge/Sphinx-docs-blue.svg
19+
:target: https://python-libs.onrender.com/
820

921
.. toctree::
1022
:maxdepth: 2

pyproject.toml

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
name = "python-libs"
44
dynamic = ["version"]
55
description = "Common Xenserver Python classes"
6-
requires-python = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*"
6+
# 3.6 is used by XS8.4, 3.11 by XS9, versions in-between are not required
7+
requires-python = ">=3.6, !=3.7.*, !=3.8.*, !=3.9.*, !=3.10.*"
78
license = {file = "LICENSE"}
89
keywords = ["xenserver", "xen-project", "libraries"]
910
authors = [
@@ -20,14 +21,10 @@ readme = "README.md"
2021
classifiers = [
2122
"Development Status :: 5 - Production/Stable",
2223
"Operating System :: POSIX :: Linux",
23-
"Programming Language :: Python :: 2.7",
2424
"Programming Language :: Python :: 3.6",
25-
"Programming Language :: Python :: 3.7",
26-
"Programming Language :: Python :: 3.8",
27-
"Programming Language :: Python :: 3.9",
28-
"Programming Language :: Python :: 3.10",
2925
"Programming Language :: Python :: 3.11",
3026
"Programming Language :: Python :: 3.12",
27+
"Programming Language :: Python :: 3.13",
3128
"Programming Language :: Python :: Implementation :: CPython",
3229
"Topic :: System :: Hardware",
3330
"Topic :: System :: Installation/Setup",

0 commit comments

Comments
 (0)