delfino-core 7.2.4

Delfino core plugin

🔌  Delfino Core   🔌

A Delfino plugin with core functionality.

Commands

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.
isort	Runs isort.
lint	Runs pylint, pycodestyle, pydocstyle.
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.
switch-python-version	Switches Python venv to a different Python version.
test	Runs pytest, coverage-report.
mypy	Run type checking on source code.
verify	Runs format, lint, mypy, test-all.

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):
  • mypy
  • format
  • dependencies-update
  • pre-commit
• For groups of commands:
  • test - for testing and coverage commands
  • lint - for all the linting commands
• For groups of groups:
  • verify - same as [mypy,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", "mypy", "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.mypy]
# 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.