🔌  Delfino Core   🔌

This is a backup of an upstream repository via a fork.

Commands

Command	Description
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.
format	Runs black code formatter and isort on source code.
lint	Run linting on the entire code base.
lint-pycodestyle	Run PEP8 checking on code.
lint-pydocstyle	Run docstring linting on source code.
lint-pylint	Run pylint on code.
switch-python-version	Switches Python venv to a different Python version.
test-all	Run all tests, and generate coverage report.
test-integration	Run integration tests.
test-unit	Run unit tests.
typecheck	Run type checking on source code.
verify-all	Runs all verification commands.

Installation

• pip: pip install delfino-core
• Poetry: poetry add -D delfino-core
• Pipenv: pipenv install -d delfino-core

Optional dependencies

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):
  • typecheck
  • format
  • dependencies-update
• For groups of commands:
  • test - for testing and coverage commands
  • lint - for all the linting commands
• For groups of groups:
  • verify-all - same as [typecheck,format,test,lint]
  • all - all optional packages

Configuration

Delfino doesn't load any plugins by default. To enable this plugin, add the following config into pyproject.toml:

[tool.delfino.plugins.delfino-core]

Plugin configuration

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 = []

# Commands to run as a quality gate in given order.
verify_commands = ["format", "lint", "typecheck", "test-all"]

# Do not install pre-commit if this is set to true.
disable_pre_commit = false

Commands configuration

Several commands have their own configuration as well:

[tool.delfino.plugins.delfino-core.typecheck]
# One or more directories where type hint will be required. By default they are optional.
strict_directories = []  

Usage

Run delfino --help.

Development

To develop against editable delfino sources:

1. Make sure delfino sources are next to this plugin:

   cd ..
   git clone https://github.com/radeklat/delfino.git

2. Install delfino as editable package:

   pip install -e ../delfino

   Note that poetry will reset this to the released package when you install/update anything.