[PROPOSAL] Public poll - Standard pip installation

[leopoldhub]

Hi,

Currently, the installation process manually moves the Python script to /usr/bin/fw-fanctrl (or other configured path).
This is a manual non-standard process that is only valid for single-file scripts.

I think that we should use the "standard" way of doing this with a setup.py file descriptor and install it with pip install instead.

This method uses the setuptools.
Several formats for the setup file are available pyproject.toml, setup.cfg and setup.py.
The exact format is yet to be decided.

This would allow us to split the already large (633 lines) script file into modules, as well as allow for versioning and possible future dependencies and developement dependencies (e.g. a file formatter or tests to ensure uniformity and stability).

What do you think about this this?

This is a public poll, feel free to give your opinion and discuss this proposal even if you are not an active developer on this project 😉

[Svenum]

The packaging/nix already uses this:

fw-fanctrl/nix/packages/fw-fanctrl.nix

Lines 24 to 40 in c79c43e

	preBuild = ''
	cat > setup.py << EOF
	from setuptools import setup
	setup(
	name="fw-fanctrl",
	description="${description}",
	url="${url}",
	platforms=["linux"],
	py_modules=[],
	scripts=[
	"fanctrl.py",
	],
	)
	EOF
	'';

So it sounds good to me.

[leopoldhub]

Hi @Svenum,

Thanks for your feedback.

Nice to see that this is already being used in some way!

What do you think about other formats, and why did you choose the setup.py one?

[Svenum]

I used it as it is the recommended way from nixos to package a python package. Thats the only reason.

[leopoldhub]

Thanks

[TamtamHero]

That's fine by me 👍

[deifactor]

For what it's worth, pip install-ing a Python script means that now you're dealing with installing all the dependencies into a shared package environment, which is messy. pipx --global is probably better (I haven't used it with --global, but I've used it for user scripts and it's worked great).