Installation¶
Add kloudmint to a project¶
kloudmint is distributed through a private package index. Ask your team lead for access and for the index URL and credentials -- they are intentionally not documented here. Once your package manager is configured with them:
pip install "kloudmint==<version>"
Pin an exact version in requirements.txt / pyproject.toml, and read the
Changelog before upgrading.
You'll also need your own web/DB stack -- kloudmint assumes:
fastapi
sqlalchemy
uvicorn # or your ASGI server of choice
Developing against a local, editable copy of kloudmint¶
If you're modifying kloudmint itself and want a project to pick up changes
immediately without reinstalling:
pip install -e /path/to/kloudmint
This points the install directly at the source instead of copying it -- edits
in kloudmint/src/kloudmint/ show up the next time the host app restarts (no
separate build/publish step needed). This relies on dev-mode-dirs = ["src"]
in pyproject.toml (added in 0.1.3) -- without it, hatchling's editable
install snapshots the source at install time instead, and edits silently
don't show up until you reinstall. If a change you made isn't taking effect
in a project with an editable install, pip uninstall kloudmint -y && pip
install -e /path/to/kloudmint again first before assuming the code is wrong.
Verify it installed correctly¶
python -c "import kloudmint; print(kloudmint.__version__)"