package the python script so it can be installed with python tooling

Adds instructions on the readme on how to do it.

The name of the main script has been changed from run.py to xcp-ng-d.ev

Adds a gitignore to ignore files produces by the packaging

Signed-off-by: Pau Ruiz Safont <[email protected]>

Author: psafont

.gitignore

@@ -0,0 +1,3 @@
+# Distribution / packaging
+build/
+*.egg-info/

README.md

@@ -22,6 +22,9 @@ If you have both installed, docker will be used by default.  If you
 want to use a specific container runtime, set `XCPNG_OCI_RUNNER` to
 the docker-compatible command to use (typically `podman` or `docker`).
 
+You'll need to install git-lfs to be able to download the source tarballs from
+git, otherwise when running xcp-ng-dev, it won't be able to extract the sources.
+
 ## Building the container image(s)
 
 You need one container image per target version of XCP-ng.
@@ -37,27 +40,33 @@ Usage: ./build.sh {version_of_XCP_ng}
 
 ## Using the container
 
-Use the `run.py` script. It accepts a variety of parameters allowing for different uses:
+Install the `xcp-ng-dev` script with however you usually install python
+binaries. For example:
+
+`uv tool install --from path/to/xcp-ng-build-env xcp-ng-build`
+`pipx install path/to/xcpng-build-env`
+
+Use `xcp-ng-dev`. It accepts a variety of parameters allowing for different uses:
 * rebuild an existing source RPM (with automated installation of the build dependencies)
 * build a package from an already extracted source RPM (sources and spec file), or from a directory that follows the rpmbuild convention (a `SOURCES/` directory and a `SPECS/` directory). Most useful for building packages from XCP-ng's git repositories of RPM sources: https://github.com/xcp-ng-rpms.
 * or simply start a shell in the build environment, with the appropriate CentOS, EPEL and XCP-ng yum repositories enabled.
 
 ```sh
-usage: run.py [-h] [-b BRANCH] [-l BUILD_LOCAL] [--define DEFINE]
-              [-r REBUILD_SRPM] [-o OUTPUT_DIR] [-n] [-p PACKAGE] [-s SRPM]
-              [-d DIR] [-e ENV] [-v VOLUME] [--rm] [--syslog] [--name NAME]
-              [-a ENABLEREPO] [--fail-on-error]
-              ...
+usage: xcp-ng-dev [-h] [-b BRANCH] [-l BUILD_LOCAL] [--define DEFINE]
+                  [-r REBUILD_SRPM] [-o OUTPUT_DIR] [-n] [-p PACKAGE]
+                  [-s SRPM] [-d DIR] [-e ENV] [-v VOLUME] [--rm] [--syslog]
+                  [--name NAME] [--ulimit ULIMIT] [-a ENABLEREPO]
+                  [--disablerepo DISABLEREPO] [--fail-on-error]
+                  ...
 
 positional arguments:
   command               Command to run inside the prepared container
 
-optional arguments:
+options:
   -h, --help            show this help message and exit
-  -b BRANCH, --branch BRANCH
-                        XCP-ng version: 7.6, 8.0, etc. If not set, will
-                        default to 8.0.
-  -l BUILD_LOCAL, --build-local BUILD_LOCAL
+  -b, --branch BRANCH   XCP-ng version: 7.6, 8.3, etc. If not set, will
+                        default to 8.3.
+  -l, --build-local BUILD_LOCAL
                         Install dependencies for the spec file(s) found in the
                         SPECS/ subdirectory of the directory passed as
                         parameter, then build the RPM(s). Built RPMs and SRPMs
@@ -71,30 +80,35 @@ optional arguments:
                         'xcp_ng_section extras', for building the 'extras'
                         version of a package which exists in both 'base' and
                         'extras' versions.
-  -r REBUILD_SRPM, --rebuild-srpm REBUILD_SRPM
+  -r, --rebuild-srpm REBUILD_SRPM
                         Install dependencies for the SRPM passed as parameter,
                         then build it. Requires the --output-dir parameter to
                         be set.
-  -o OUTPUT_DIR, --output-dir OUTPUT_DIR
+  -o, --output-dir OUTPUT_DIR
                         Output directory for --rebuild-srpm and --build-local.
   -n, --no-exit         After executing either an automated build or a custom
                         command passed as parameter, drop user into a shell
-  -p PACKAGE, --package PACKAGE
+  -p, --package PACKAGE
                         Packages for which dependencies will be installed
-  -s SRPM, --srpm SRPM  SRPMs for which dependencies will be installed
-  -d DIR, --dir DIR     Local dir to mount in the image. Will be mounted at
+  -s, --srpm SRPM       SRPMs for which dependencies will be installed
+  -d, --dir DIR         Local dir to mount in the image. Will be mounted at
                         /external/<dirname>
-  -e ENV, --env ENV     Environment variables passed directly to docker -e
-  -v VOLUME, --volume VOLUME
-                        Volume mounts passed directly to docker -v
+  -e, --env ENV         Environment variables passed directly to docker -e
+  -v, --volume VOLUME   Volume mounts passed directly to docker -v
   --rm                  Destroy the container on exit
   --syslog              Enable syslog to host by mounting in /dev/log
   --name NAME           Assign a name to the container
-  -a ENABLEREPO, --enablerepo ENABLEREPO
+  --ulimit ULIMIT       Ulimit options passed directly to docker run
+  -a, --enablerepo ENABLEREPO
                         additional repositories to enable before installing
                         build dependencies. Same syntax as yum's --enablerepo
-                        parameter. Available additional repositories: xcp-ng-
-                        updates_testing, xcp-ng-extras, xcp-ng-extras_testing.
+                        parameter. Available additional repositories: check
+                        files/xcp-ng.repo.*.x.in.
+  --disablerepo DISABLEREPO
+                        disable repositories. Same syntax as yum's
+                        --disablerepo parameter. If both --enablerepo and
+                        --disablerepo are set, --disablerepo will be applied
+                        first
   --fail-on-error       If container initialisation fails, exit rather than
                         dropping the user into a command shell
 ```
@@ -103,7 +117,7 @@ optional arguments:
 
 Rebuild an existing source RPM (with automated installation of the build dependencies)
 ```sh
-./run.py -b 8.0 --rebuild-srpm /path/to/some-source-rpm.src.rpm --output-dir /path/to/output/directory --rm
+xcp-ng-dev -b 8.2 --rebuild-srpm /path/to/some-source-rpm.src.rpm --output-dir /path/to/output/directory --rm
 ```
 
 Build from git (and put the result into RPMS/ and SRPMS/ subdirectories)
@@ -116,7 +130,7 @@ git clone https://github.com/xcp-ng-rpms/xapi.git
 # ... Here add your patches ...
 
 # Build.
-/path/to/run.py -b 8.0 --build-local xapi/ --rm
+xcp-ng-dev -b 8.2 --build-local xapi/ --rm
 ```
 
 **Important switches**
@@ -157,11 +171,11 @@ make
 
 If you'd like to develop using the tools on your host and preserve the changes
 to source and revision control but still use the container for building, you
-can do using by mouning a volume in the container, using the `-v` option to mount
+can do using by mounting a volume in the container, using the `-v` option to mount
 a directory from your host to a suitable point inside the container. For
 example, if I clone some repos into a directory on my host, say `/work/code/`,
 then I can mount it inside the container as follows:
 
 ```sh
-./run.py -b 8.0 -v /work/code:/mnt/repos
+xcp-ng-dev -b 8.2 -v /work/code:/mnt/repos
 ```

pyproject.toml

@@ -0,0 +1,20 @@
+[project]
+name = "xcp-ng-build"
+description = "A tool to create XCP-ng-based build environments"
+readme = "README.md"
+requires-python = ">=3.9"
+license = "MIT"
+license-files = ["LICENSE"]
+dynamic = ["version"]
+
+[project.scripts]
+xcp-ng-dev = "xcp_ng_dev.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/xcp-ng/xcp-ng-build-env/"
+
+[build-system]
+requires = ["setuptools >= 77.0.3", "setuptools-scm>=8"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]