A Streamlit template for Recursive Zero repository
- Python ≥ 3.11
- Poetry ≥ 2.2.1
- Streamlit ≥ 1.49.1
curl -sSL https://install.python-poetry.org | python3 -
# OR
pip install poetry>=2.2.1poetry config virtualenvs.path /your/desired/pathEnsure below files are configured (create if not exist) properly to run the project;
.env.local,.env, and.streamlit/secrets.toml
poetry lock --no-cache --regenerate
poetry install --all-extras --with devOr manually
poetry installpoetry run sample devAccess: http://localhost:8501
poetry run sample api
# OR
python src/api/fast_api.pyAccess: http://127.0.0.1:5000
Pre-commit hooks are enabled. If commits fail, run:
poetry run lintor run individual
poetry run black .
poetry run flake8 .
poetry run mypy .
poetry run ruff check .poetry clean
poetry buildArtifacts in dist/
- sample-x.y.0-py3-none-any.whl
- sample-x.y.0.tar.gz
python -m venv .venv-dist
source .venv-dist/bin/activate
# Windows
.venv-dist\Scripts\activatepip install dist/*.whl
pip install --upgrade dist/*.whl
# Install extras:
pip install samplesample dev → Launch Streamlit UI
sample api → Launch FastAPI
current version will be printed on start of above commands.
these hooks will
- Check for lint and audit for security before commit
- Append branch name in commit message
- Generate requirements.txt on checkout on new branch
# Install git hooks
poetry run ./scripts/setup-hooks.shthere is .vscode/Python.code-profile file; import this as a profile in vscode which include necessary extension for python development.
sometimes there might be chances that virtual environment get corrupted then delete the old virtual environment and start afresh.
poetry env info
# this will provide virtual environment name
poetry env remove <environment-full-name>