A transparent discovery signal based on current public GitHub metadata.
Recent activity35% weight
52
Community adoption25% weight
12
Maintenance state20% weight
100
License clarity10% weight
100
Project information10% weight
100
This score does not audit code, security, maintainers, documentation quality, or suitability. Verify the repository and its current documentation before adoption.
Customized function decorator @async_function to enable function to run asynchronously; @peewee_table class decorator to register ORM tables; @elapsed_time(level="INFO") to profile a function elapsed time.
# Install uv
$ curl -LsSf https://astral.sh/uv/install.sh | sh
# For Windows PowerShell
$ powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
# Or use winget
$ winget install --id=astral-sh.uv
Install dependencies, with optional dependency group test
$ uv sync --extra test --extra dev
Install mypy types
$ uv run mypy --install-types
Setup pre-commit and pre-push hooks
$ uv run pre-commit install -t pre-commit
$ uv run pre-commit install -t pre-push
Useful Commands
Run Python Module
$ uv run python -m python_boilerplate
Run Python Script
Append your project's root directory toPYTHONPATH — In any environment you wish to run your Python application such as Docker, vagrant or your virtual environment i.e. in bin/activate, run the below command:
# Ensure `pwd` is the root directory of the project
$ PYTHONPATH=`pwd` uv run python3 python_boilerplate/demo/pandas_usage.py
$ PYTHONPATH=`pwd` uv run python3 python_boilerplate/demo/multithread_and_thread_pool_usage.py
# Run the main module
$ PYTHONPATH=`pwd` uv run python3 python_boilerplate/__main__.py
# Run a pytest script
$ pytest --log-cli-level=DEBUG --capture=no tests/common/test_debounce_throttle.py
# Run a pytest script with `-k` EXPRESSION
$ pytest --log-cli-level=DEBUG --capture=no tests/common/test_debounce_throttle.py -k 'test_debounce'
# For more details of pytest command
$ uv run pytest --help
For Windows Terminal,
# Ensure `$PWD.Path` is the root directory of the project
$ $env:PYTHONPATH=$PWD.Path; uv run python .\python_boilerplate\demo\pandas_usage.py
$ $env:PYTHONPATH=$PWD.Path; uv run python .\python_boilerplate\demo\multithread_and_thread_pool_usage.py
# Run the main module
$ $env:PYTHONPATH=$PWD.Path; uv run python .\python_boilerplate\__main__.py
Run with pytest, analyze code coverage, generate HTML code coverage reports, fail the test if coverage percentage is under 90%,
$ uv run pytest --cov --cov-report html --cov-fail-under=85 --capture=no --log-cli-level=INFO
Benchmark with pytest,
$ uv run pytest --capture=no --log-cli-level=ERROR -n 0 --benchmark-only
Conventional Changelog CLI
Install global dependencies (optional if installed):
$ npm install -g conventional-changelog-cli
This will not overwrite any previous changelogs. The above generates a changelog based on commits since the last semver tag that matches the pattern of "Feature", "Fix", "Performance Improvement" or "Breaking Changes".
