A Delfino plugin with core functionality.
| Command | Description |
|---|---|
| black | Runs black. |
| coverage-open | Open coverage results in default browser. |
| coverage-report | Analyse coverage and generate a term/HTML report. |
| dependencies-update | Manages the process of updating dependencies. |
| ensure-pre-commit | Ensures pre-commit is installed and enabled. |
| format | Runs ensure-pre-commit, pyupgrade, isort, black. |
| gh | Extends gh or passes through. |
| glab | Extends glab or passes through. |
| isort | Runs isort. |
| lint | Runs ruff, pylint, pycodestyle, pydocstyle. |
| mypy | Run type checking on source code. |
| pre-commit | Run all pre-commit stages in the current project... |
| pycodestyle | Run PEP8 checking on code. |
| pydocstyle | Run docstring linting on source code. |
| pylint | Run pylint on code. |
| pytest | Runs pytest for individual test suites. |
| pytest-integration | Run integration tests. |
| pytest-unit | Run unit tests. |
| pyupgrade | Runs pyupgrade with automatic version discovery. |
| ruff | Run ruff. |
| switch-python-version | Switches Python venv to a different Python version. |
| test | Runs pytest, coverage-report. |
| vcs | Alias for gh/glab with auto-detection. |
| verify | Runs format, lint, mypy, test. |
- pip:
pip install delfino-core - Poetry:
poetry add -D delfino-core - Pipenv:
pipenv install -d delfino-core
Each project may use different sub-set of commands. Therefore, dependencies of all commands are optional and checked only when the command is executed.
Using [all] installs all the optional dependencies used by all the commands. If you want only a sub-set of those dependencies, there are finer-grained groups available:
- For individual commands (matches the command names):
mypyformatdependencies-updatepre-commitvsc
- For groups of commands:
test- for testing and coverage commandslint- for all the linting commands
- For groups of groups:
verify- same as[mypy,format,test,lint]all- all optional packages
Delfino doesn't load any plugins by default. To enable this plugin, add the following config into pyproject.toml:
[tool.delfino.plugins.delfino-core]
This plugin has several options. All the values are optional and defaults are shown below:
[tool.delfino.plugins.delfino-core]
# Source files - may have different rules than tests (usually stricter)
sources_directory = "src"
# Test files
tests_directory = "tests"
# Where to store reports generated by various tools
reports_directory = "reports"
# Types of tests you have nested under the `tests_directory`. Will be executed in given order.
test_types = ["unit", "integration"]
# One or more module to wrap `pytest` in, executing it as `python -m <MODULE> pytest ...`
pytest_modules = []
# Coommand groups and commands to run as a quality gate in given order.
verify_commands = ["format", "lint", "mypy", "test"]
format_commands = ["ensure-pre-commit", "pyupgrade", "isort", "black"]
lint_commands = ["ruff", "pylint", "pycodestyle", "pydocstyle"]
test_commands = ["pytest", "coverage-report"]
# Do not install pre-commit if this is set to true.
disable_pre_commit = falseSeveral commands have their own configuration as well.
[tool.delfino.plugins.delfino-core.mypy]
# One or more directories where type hint will be required. By default they are optional.
strict_directories = [] [tool.delfino.plugins.delfino-core.vcs]
# Enable to manually specify the branch prefix. By default it is set to git username.
# branch_prefix = ""
[tool.delfino.plugins.delfino-core.vcs.issue_tracking]
# Prefix for issue numbers, including a trailing hyphen if used. If not set, just the issue numbers will be used.
# issue_prefix = "ISSUE-"
# URL for the issue tracker. If not set, issue tracker integration will be disabled.
# Implemented trackers: Jira.
# tracker_url = "https://<SUBDOMAIN>.atlassian.net"
# Environment variable name for the issue tracking username. If not set, 'ISSUE_TRACKER_USERNAME' will be used by default.
# username_env_var = ""
# Environment variable name for the issue tracking API key. If not set, 'ISSUE_TRACKER_API_KEY' will be used by default.
# api_key_env_var = ""Run delfino --help.
To develop against editable delfino sources:
- Make sure
delfinosources are next to this plugin:cd .. git clone https://github.com/radeklat/delfino.git - Install
delfinoas editable package:Note that poetry will reset this to the released package when you install/update anything.pip install -e ../delfino