How to deploy a python / hy package29 Nov 2022
You can pip install from the local git repo by putting the following in requirements.txt:
Notice the different format to what git itself uses to point to a remote repository. It’s also possible to install direct from the local source tree, e.g.:
python -m pip install /src/program
This last way may be the easiest, doing versioning on the git server and installing from /src.
A Python project will consist of a root directory with the name of the project. Somewhere inside this will be included a directory which will constitute the main installable package. Most often this has the same name as the project (This is not compulsory but makes things a bit simpler. Inside that package directory, alongside your python files, create a file called
__init__.py. This file can be empty, and it denotes the directory as a python package. When you pip install, this directory will be installed and become importable.
A simple project may have this structure:
graphics ├── LICENSE ├── graphics │ ├── __init__.py │ └── screen.hy ├── README.md ├── pyproject.toml └── setup.cfg
This means pip will throw away the top-level stuff (README etc.).
The same source goes on to recommend setuptools to make the package installable, provide package metadata, dependencies etc.
The python docs tutorials recommend setup.cfg as a simpler static alternative. However setup.py could allow using the git tag as a version.