Properly package the python script #36

psafont · 2025-07-08T16:13:12Z

This allows the script to be installed and not have to refer to its whole path every time it's invoked.

The name of the installed binary is xcp-ng-dev.

Also fixes a couple of nits I found while trying to run the script

obsoletes #32

Signed-off-by: Gaëtan Lehmann <[email protected]> Signed-off-by: Pau Ruiz Safont <[email protected]>

pyproject.toml

README.md

run.py

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

README.md

stormi · 2025-07-09T16:28:42Z

README.md

+
+## Installation
+
+Clone this repository and install the `xcp-ng-dev` package:


I'm not fully convinced by the xcp-ng-dev name for a command. It probably lacks an action verb for me. I also find xcp-ng-dev-build ambiguous because when we run the build env, that's also for building stuff usually. And we "build" software a lot more often than we "build" the container. Not that the old names are better, sure :).

Something that is not quite right at the moment is also the fact that we have a single multipurpose run.py command. How about adding a mandatory parameter to it that says what action it's supposed to do? start to start the container without automatically starting a build, and build to start the container, install the deps, and build. These are the two main uses of the container at the moment. And, translated as installed commands from the package, this would give:

xcp-ng-build-env-run = start the container (== run.py start)

xcp-ng-dev-build = start the container, install the deps, do the build (== run.py build)

xcp-ng-build-env-create = avoiding the word "build" here, but that's actually build.sh that could probably rename to create.sh.

Maybe shell would be a more descriptive action than start in this context? (xcp-ng-build-env-shell?) (OK it's not an action verb, but maybe still descriptive enough?)

xcp-ng-dev-build = start the container, install the deps, do the build (== run.py build)

did you mean xcp-ng-build-env-build?

In any case, using separate entrypoints would require some surgery in the previously-run.py, and #35 already touches quite a bit, maybe this idea can be implemented after that other PR?

xcp-ng-build-env-build felt awkward so I figured it was not so important to have the same prefix for every command and we could have a shorter one just for the one we use most. And it does perform a build in the context of development. Looks like this idea hasn't seduced you :)

maybe this idea can be implemented after that other PR

Yes, but I think we should at least group "packaging the scripts" and "creating separate entry points". So maybe both after #35?

xcp-ng-build-env-build felt awkward

Maybe xcpng-buildenv-build would feel less so (I'm not a big fan of too many hyphens 😉)

I'm not fully convinced by the xcp-ng-dev name for a command. It probably lacks an action verb for me.

It's missing it on purpose: the command can do several things: drop into a shell, or do a local build, for example.

How about adding a mandatory parameter to it that says what action it's supposed to do?

That's what I wanted to explore next, but wanted to restrict the scope of the PR because I haven't used the tool too much.

In general I would like the command to be just one, and feed it actions:xcp-ng-dev shell, xcp-ng-dev build

xcp-ng-build-env-create = avoiding the word "build" here, but that's actually build.sh that could probably rename to create.sh.

Yes, it's awkward as it is, using env-create might be better, but I do want to keep the common prefix, it's different from the other commands as they have their action separate from the command. So I'll go with xcp-ng-dev-env-create.

I do think that #35 should be merged before this PR, and others that change the interface.

xcp-ng-dev shell, xcp-ng-dev build and xcp-ng-dev-env-create look like good names to me.

I've renamed build.sh to xcp-ng-dev-env-create. We can rework xcp-ng-dev later

Personnally, I'd prefer one single big change in how the build env is supposed to be used rather than two successive changes, as in each case people will have to change their habits.

I'll wait to do the rework until the PR for xcp 9 is merged, then.

README.md

stormi · 2025-07-16T14:05:03Z

README.md

+like `pipx install --editable .`
+
+Using the `--editable` flag will allow you to update the cli tools just by
+updating the contents of the git reopsitory, without reinstalling.


Suggested change

updating the contents of the git reopsitory, without reinstalling.

updating the contents of the git repository, without reinstalling.

stormi · 2025-07-16T14:05:32Z

README.md

+or `pipx install .`
+
+After this, two new commands will be available: `xcp-ng-dev-env-create` and
+`xcp-ng-dev`,


The sentence ends with a comma

stormi · 2025-07-16T14:06:57Z

README.md

@@ -157,11 +124,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


No from your change, but as you already fixed something in the sentence, I suggest:

Suggested change

can do using by mounting a volume in the container, using the `-v` option to mount

can do so by mounting a volume in the container, using the `-v` option to mount

... Or any better wording.

ydirson

Not as atomic as we usually do, but let's go forward

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]>

This needed a small bit of python glue code Signed-off-by: Pau Ruiz Safont <[email protected]>

pass mount flag required with podman and selinux

51f614c

Signed-off-by: Gaëtan Lehmann <[email protected]> Signed-off-by: Pau Ruiz Safont <[email protected]>

stormi requested a review from ydirson July 8, 2025 16:22

psafont changed the title ~~pass mount flag required with podman and selinux~~ Package run.py in a python package Jul 9, 2025

psafont marked this pull request as draft July 9, 2025 09:48

psafont force-pushed the dev/pau/package branch 2 times, most recently from 82cdbd4 to 77821cc Compare July 9, 2025 10:24

psafont marked this pull request as ready for review July 9, 2025 10:24

psafont force-pushed the dev/pau/package branch from 77821cc to 230d069 Compare July 9, 2025 11:04

ydirson requested changes Jul 9, 2025

View reviewed changes

pyproject.toml Outdated Show resolved Hide resolved

pyproject.toml Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

run.py Outdated Show resolved Hide resolved

run.py Show resolved Hide resolved

run.py: use a default ulimit that allows xapi's tests to pass

ef53177

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

psafont force-pushed the dev/pau/package branch 5 times, most recently from a8e4bd2 to f1df55e Compare July 9, 2025 12:03

psafont changed the title ~~Package run.py in a python package~~ Properly package the python script Jul 9, 2025

psafont force-pushed the dev/pau/package branch 2 times, most recently from b40c199 to f6378c7 Compare July 9, 2025 14:16

stormi reviewed Jul 9, 2025

View reviewed changes

ydirson reviewed Jul 10, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

psafont force-pushed the dev/pau/package branch 3 times, most recently from 61d06e3 to 5790db2 Compare July 11, 2025 14:19

stormi reviewed Jul 16, 2025

View reviewed changes

ydirson approved these changes Jul 17, 2025

View reviewed changes

psafont force-pushed the dev/pau/package branch from 5790db2 to 1c8d45d Compare July 17, 2025 08:44

Move build.sh to the new python package as xcp-ng-dev-build

950896f

This needed a small bit of python glue code Signed-off-by: Pau Ruiz Safont <[email protected]>

psafont force-pushed the dev/pau/package branch from 1c8d45d to 950896f Compare July 17, 2025 08:45


		## Installation

		Clone this repository and install the `xcp-ng-dev` package:

	updating the contents of the git reopsitory, without reinstalling.
	updating the contents of the git repository, without reinstalling.

	can do using by mounting a volume in the container, using the `-v` option to mount
	can do so by mounting a volume in the container, using the `-v` option to mount

Properly package the python script #36

Are you sure you want to change the base?

Properly package the python script #36

Uh oh!

Conversation

psafont commented Jul 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stormi Jul 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ydirson left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

psafont commented Jul 8, 2025 •

edited

Loading

stormi Jul 9, 2025 •

edited

Loading