A collection of command line helper scripts wrapping tools used during Python development.
🧰 Delfino 🧰
The Ultimate Command Line Companion for Your Projects
Tired of managing scattered scripts? Say goodbye to complexity with Delfino!
Delfino is a powerful wrapper around Click, the popular command line interface package. It automatically discovers and executes Click commands in your project. But Delfino doesn't stop there - it takes it a step further by allowing you to create plugins, making script distribution and installation a breeze.
Why choose Delfino?
- Streamline Scripts: Consolidate all your helper scripts into a single, easy-to-use entry point. No more hunting for scripts or dealing with convoluted aliases. Simply use delfino followed by the script name and options.
- Reusable Plugins: Package your helper scripts as plugins and install them with pip. Maintain consistency across projects and easily incorporate updates through a flexible configuration system.
- Simplify Tooling: Delfino extends Click with advanced features like pass-through command-line options and seamless handling of file lists. Say goodbye to verbosity and hello to optimized workflows.
Don't let scattered scripts and complex tooling slow you down. Embrace Delfino and revolutionize your command line experience. Try Delfino today and unlock simplicity in your projects!
Table of content
- Existing plugins
- Advanced usage
pip install delfino
poetry add --group=dev delfino
pipenv install -d delfino
pip install delfino[completion]
poetry add --group=dev delfino[completion]
pipenv install -d delfino[completion]
to enable auto-completion.
All configuration is expected to live in one of the following files:
pyproject.tomlin the project root
.delfinorcin the project root - to allow dev specific config, not source controlled or for non-Python projects
.delfinorcin the user home directory - for user tools available in the system
If multiple files are discovered, only the highest one in the list will be used.
The format for
.delfinorc is the same as for
delfino --help to see all available commands and their usage.
Delfino is a simple wrapper around Click commands. Any Click command will be accepted by Delfino.
Delfino looks for any
click.Command sub-class in the following locations:
commandsfolder in the root of the project (next to the
pyproject.tomlfile). This location is useful for commands that don't need to be replicated in multiple locations/projects. To change the default location, use the
tool.delfino.local_command_foldersconfig option. It allows specifying more than one folder.
- python module import path (
<IMPORT_PATH>) specified by
entry_pointof a plugin:
[tool.poetry.plugins] # Optional super table [tool.poetry.plugins."delfino.plugin"] "delfino-<PLUGIN_NAME>" = "<IMPORT_PATH>"
- Folder specified in the config file under
Any files starting with an underscore, except for
__init__.py, will be ignored.
Warning Folders are NOT inspected recursively. If you place any commands into nested folders, they will not be loaded by Delfino.
- Create a
- Create a
commands/__init__.pyfile, with the following content:
import click @click.command() def command_test(): """Tests commands placed in the `commands` folder are loaded.""" print("✨ This command works! ✨")
- See if Delfino loads the command. Open a terminal and in the root of the project, call:
delfino --help. You should see something like this:
Usage: delfino [OPTIONS] COMMAND [ARGS]... Options: --help Show this message and exit. Commands: ... command-test Tests commands placed in the `commands` folder... ...
- Run the command with
If you'd like to use one or more commands in multiple places, you can create a plugin. A plugin is just a regular Python package with specific entry point telling Delfino it should use it. It can also be distributed as any other Python packages, for example via Pypi.
The quickest way to create one is to use a Delfino plugin cookiecutter template, which asks you several questions and sets up the whole project.
Plugins can greatly reduce code duplication and/or promote your own standards in multiple places. For example, you can create a plugin wrapping common linting tools that you use on your projects, including their default configuration. Keeping the rules and creating new projects with the same style suddenly becomes a matter of installing one Python library.
Each plugin can contain one or more Click commands that are automatically discovered and exposed by Delfino. See
delfino-demo for a minimal plugin, which provide a
demo command printing out a message.
|delfino-demo||A minimal plugin example for Delfino. Contains one command printing a message.|
|delfino-core||Commands wrapping tools used during every day development (linting, testing, dependencies update).|
|delfino-docker||Docker build helper script.|
Enabling a plugin
For security reasons, plugins are disabled by default. To enable a plugin, you have to include it in the
By default, all commands are enabled. Use
disable_commands to show only a subset of commands. If both used, disabled commands are subtracted from the set of enabled commands.
# [tool.delfino.plugins.<PLUGIN_NAME_A>] # enable_commands = [<COMMAND_NAME>] # disable_commands = [<COMMAND_NAME>] # [tool.delfino.plugins.<PLUGIN_NAME_B>] # enable_commands = [<COMMAND_NAME>] # disable_commands = [<COMMAND_NAME>]
You can either attempt to install completions automatically with:
or generate it with:
and manually put it in the relevant RC file.
The auto-completion implementation is dynamic so that every time it is invoked, it uses the current project. Each project can have different commands or disable certain commands it doesn't use. And dynamic auto-completion makes sure only the currently available commands will be suggested.
The downside of this approach is that evaluating what is available each time is slower than a static list of commands.
Running external programs
It is up to you how you want to execute external processes as part of commands (if you need to at all). A common way in Python is to use
subprocess.run. Delfino comes with its own
run implementation, which wraps and simplifies
subprocess.run for the most common use cases:
subprocess.runarguments - you can pass in either a string or a list. Either way,
subprocess.runwill be executed correctly.
- Handling errors from the execution via the
on_errorargument. Giving the option to either ignore the errors and continue (
PASS), not continue and clean exit (
EXIT) or not continue and abort with error code (
- Setting environment variables.
- Logging what is being executed in the debug level.
# commands/__init__.py import click from delfino.execution import run, OnError @click.command() def test(): run("pytest tests", on_error=OnError.ABORT)
If you put several commands into one plugin, you can make some dependencies of some commands optional. This is useful when a command is not always used, and you don't want to install unnecessary dependencies. Instead, you can check if a dependency is installed only when the command is executed with
# commands/__init__.py import click from delfino.validation import assert_pip_package_installed try: from git import Repo except ImportError: pass @click.command() def git_active_branch(): assert_pip_package_installed("gitpython") print(Repo(".").active_branch)
In the example above, if
gitpython is not installed, delfino will show the command but will fail with suggestion to install
gitpython only when the command is executed. You can also add
disable_commands config in places where you don't intend to use it.
This way you can greatly reduce the number of dependencies a plugin brings into a project without a need to have many small plugins.
You can store an arbitrary object in the Click context as
click.Context.obj. Delfino utilizes this object to store an instance of
AppContext, which provides access to project related information. If you need to, you can still attach arbitrary attributes to this object later.
You can pass this object to your commands by decorating them with
# commands/__init__.py import click from delfino.models.app_context import AppContext @click.command() @click.pass_obj def print_app_version(obj: AppContext): print(obj.pyproject_toml.tool.poetry.version)
Plugin settings are expected to live in the
pyproject.toml file. To prevent naming conflicts, each plugin must put its settings under
tool.delfino.plugins.<PLUGIN_NAME>. It also allows Delfino to pass these settings directly to commands from these plugins.
Delfino loads, parses, validates and stores plugin settings in
AppContext.plugin_config. If not specified otherwise (see below), it will be an instance of
PluginConfig, with any extra keys unvalidated and in JSON-like Python objects.
You can add additional validation to your plugin settings by sub-classing the
PluginConfig , defining expected keys, default values and/or validation. Delfino utilizes
pydantic to create data classes.
Delfino also needs to know, which class to use for the validation. To do that, switch to
delfino.decorators.pass_app_context instead of
# pyproject.toml [tool.delfino.plugins.delfino_login_plugin] username = "user"
# commands/__init__.py import click from delfino.models.pyproject_toml import PluginConfig from delfino.models.app_context import AppContext from delfino.decorators import pass_app_context class LoginPluginConfig(PluginConfig): login: str @click.command() @pass_app_context(LoginPluginConfig) def login(app_context: AppContext[LoginPluginConfig]): print(app_context.plugin_config.login)
AppContext class is generic. Defining the
PluginConfigType (such as
AppContext[LoginPluginConfig] in the example above) enables introspection and type checks.
Project specific overrides
It is likely your projects will require slight divergence to the defaults you encode in your scripts. The following sections cover the most common use cases.
You can pass additional arguments to downstream tools by decorating commands with the
# commands/__init__.py from typing import Tuple import click from delfino.decorators import pass_args from delfino.execution import run, OnError @click.command() @pass_args def test(passed_args: Tuple[str, ...]): run(["pytest", "tests", *passed_args], on_error=OnError.ABORT)
Then additional arguments can be passed either via command line after
delfino test -- --capture=no
Or via configuration in the
[tool.delfino.plugins.<PLUGIN>.test] pass_args = ['--capture=no']
Either way, both will result in executing
pytest tests --capture=no.
You can override files passed to downstream tools by decorating commands with the
# commands/__init__.py from typing import Tuple import click from delfino.decorators import files_folders_option from delfino.execution import run, OnError @click.command() @files_folders_option def test(files_folders: Tuple[str, ...]): if not files_folders: files_folders = ("tests/unit", "tests/integration") run(["pytest", *files_folders], on_error=OnError.ABORT)
Then the default
"tests/unit", "tests/integration" folders can be overridden either via command line options
delfino test -f tests/other
Or via configuration in the
[tool.delfino.plugins.<PLUGIN>.test] files_folders = ['tests/other']
Either way, both will result in executing
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.