Pixi manages packages broarder sence and thus replaces conda. UV is a package which is a replacement for pip in package managing for python. The alternative python package template for uv can be found at HKV-products-services/python_package_template_uv. Depending on your needs one is more suited than the other.
This template package contains core functionality for a python package, developed to showcase and speed up the process of developing a python package. This Python package template is developed by HKV, though based heavily on other open source projects and is published under the GNU GPL-3 license.
The current package name is python_package_template and # Python package template, if you search for this in your IDE (e.g. VS Code) you can replace these with your given name.
This repo has an example pre-commit configuration in .pre-commit-config.yaml.
Depending on your needs you might want to uncomment certain sections.
Let us know by making an issue if we missed a useful pre-commit.
Use pre-commit install --hook-type pre-commit --hook-type pre-push to automatically run pre-commit.
In the folder .github there are four workflows which run automatically.
You will need to adjust these depending on your needs.
Read bellow for more information on pixi and a quick guideline you can include in your project.
run pip install Python_package_template
To manage the environment we use Pixi.
windows
iwr -useb https://pixi.sh/install.ps1 | iexLinux/Mac
curl -fsSL https://pixi.sh/install.sh | bashWith the Pixi command in powershell install the python environment:
cd ../python_package_template
pixi installThe pixi.lock file loads the correct packages and downloads to the .pixi file, you can use this environment in developing and resting.
For questions about how to use this package contact dupuits@hkv.nl or haasnoot@hkv.nl.