NTD-Modelling-Consortium / ntd-model-sch

NTD SCH model
MIT License
0 stars 6 forks source link

Install with `pip` through `pyproject.toml` #43

Closed tlestang closed 3 months ago

tlestang commented 3 months ago

This PR makes the package configuration closer to latest Python packaging standards and conventional workflows.

Currently, the README prescribes the use of pipenv for installing the SCH package, with the package configuration and metadata defined in a setup.py and Pipfile files.

This

Invoking setup.py directly (e.g. python setup.py install) or not providing a minimal pyproject.toml configuration file is deprecated. In the case of the SCH package, all the defined configuration and metadata can be migrated from the setup.py file to the pyproject.toml file, which is the standard configuration file nowadays.

If pipenv is a useful tool for managing the installation of Python packages, it acts at a level above the standard Python package manager pip. There are other alternatives, such as poetry, conda, pyenv, rye, pdm or hatch. I think the installation instruction should not make any prescription(s) for a particular tool, but instead mention that the installation is nothing more that the conventional pip install command that most users would exepct. The README file could, however, make recommendations regarding the use of tools to manage package installations.

tlestang commented 3 months ago

Closes https://github.com/NTD-Modelling-Consortium/endgame-project/issues/41

igorclark commented 3 months ago

Hey, thanks @tlestang - I'll see if I can do a test install in the runner venv with this, hopefully later today or certainly tomorrow.