All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog
and this project adheres to Semantic Versioning.
Types of changes are:
tool.delfino.plugins.delfino-core.branch_prefix
has been moved to tool.delfino.plugins.delfino-core.vcs.branch_prefix
.tool.delfino.plugins.delfino-core.typecheck
has been moved to tool.delfino.plugins.delfino-core.mypy
.In the vcs
/gh
/glab
pr
/mr
start
commands, the integration attempts to fetch issue title. The resulting branch name will be set to <ISSUE_PREFIX>-<ISSUE_NUMBER>/<ISSUE_TITLE>
and the first commit message will be set to <ISSUE_TITLE>
. Use the issue number in place of the title to trigger it. For example delfino mr start 123
.
tool.delfino.plugins.delfino-core.issue_tracking
issue_prefix
- The issue prefix (including a trailing dash).tracker_url
- The issue tracker URL. If not set, the integration will be disabled.username_env_var
- The environment variable containing the username for the issue tracker. Defaults to DELFINO_CORE_ISSUE_TRACKING_USERNAME
.api_key_env_var
- The environment variable containing the API key for the issue tracker. Defaults to DELFINO_CORE_ISSUE_TRACKING_API_KEY
.vcs
- Installs httpx
used for fetching issue title.vcs
/gh
/glab
commands. Now not only trailing special characters are removed but also leading ones and ones around slashes. Example: !breaking: feature / branch.
becomes breaking_feature/branch
.@me
instead of me
as assignee when creating a Gitlab MR using vcs
/glab
pr
/mr
create
/start
commands.vcs
/glab
pr
/mr
create
/start
commands.ruff
in version 0.5.0
has removed support for ruff <path>
syntax and requires ruff check <path>
instead. The ruff
command has been updated to reflect this change, however it will allow this to be overridden by supplying a different action as the extra argument after --
.vcs
/glab
pr
/mr
create
/start
commands.main
in vcs
/gh
/glab
pr
/mr
start
command./
in branch name for vcs
/gh
/glab
commands.vcs
commands. By default, it is set to the git username:
[tool.delfino.plugins.delfino-core]
branch_prefix = "your_prefix/"
glab
that wraps the glab
CLI tool. Similar to the existing gh
command, it has the following subcommands:
glab mr create
glab mr start
glab mr view
vcs
that auto-selects the correct VCS CLI tool in the current directory based on git remote. Currently, gh
and glab
are supported. It has the following subcommands:
vcs pr/mr create
vcs pr/mr start
vcs pr/mr view
PyYAML
when the pre-commit
command is not used.ruff
as an optional dependency in the verify
group.dependencies-update
introduced by update of delfino
.dependencies-update
strips final underscore from the branch name.verify
and dependencies-update
commands with spinners.ruff
. It has been also added to the lint
command group.gh
with additional functionality on top of the gh
CLI tool:
gh pr create
adds sensible defaults for a single developer per branch to ask for almost no input. It also accepts a title of the PR as free text after the commands, as long as it doesn't start with a -
.gh pr start
is a new command, which is like gh pr create
, but also creates a new branch with a name matching the PR title, prefixed with current user's username. This branch is based off latest main and pushed to remote with an empty commit.gh pr view
default to opening the PR in a web browser.dependencies-updates
now correctly defaults to "Yes" if no answer provided.This version renames several commands and command groups to be more consistent and predictable. The intention is to name commands using the same name as the underlying tool. Several commands were also turned into command groups of individual commands, to allow more flexibility in configuration.
Old name | New name |
---|---|
lint-pylint |
pylint |
lint-pydocstyle |
pydocstyle |
lint-pycodestyle |
pycodestyle |
typecheck |
mypy |
test |
pytest |
test-unit |
pytest-unit |
test-integration |
pytest-integration |
verify-all
command group is now called verify
, to match the existing format
and lint
command groups. However, the configration option to override the verify
command group is still tool.delfino.plugins.delfino-core.verify_commands
as it already matched the new name.Affects optional dependencies installed with delfino-core
. Update your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all |
verify |
Affects list of commands visible in given command groups. Update tool.delfino.plugins.delfino-core.<COMMAND_GROUP_NAME>_commans
in your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all_commands |
verify_commands |
This is an implementation detail that should not be relied on, but it's listed here for completeness. Command and command group names were changed to match a pattern run_<COMMAND_NAME>
and run_group_<COMMAND_GROUP_NAME>
. This is to prevent clashes with the names of the underlying tools and easier discoverability.
Old name | New name |
---|---|
coverage_open |
run_coverage_open |
coverage_report |
run_coverage_report |
dependencies_update |
run_dependencies_update |
lint |
run_group_lint |
lint_pycodestyle |
run_pycodestyle |
lint_pydocstyle |
run_pydocstyle |
lint_pylint |
run_pylint |
pre_commit |
run_pre_commit |
run_format |
run_group_format |
switch_python_version |
run_switch_python_version |
test |
run_group_test |
test_all |
run_pytest |
test_integration |
run_pytest_integration |
test_unit |
run_pytest_unit |
typecheck |
run_mypy |
verify_all |
run_group_verify |
ensure-pre-commit
pyupgrade
isort
black
format
command has been turned into a command group of individual.
ensure-pre-commit
, pyupgrade
, isort
and black
.tool.delfino.plugins.delfino-core.format_commands
option in the pyproject.toml
file.test
has been formally changed to a command group (functionally, it was already a group).
pytest
and coverage-report
.tool.delfino.plugins.delfino-core.test_commands
option in the pyproject.toml
file.pre-commit
command to run all stages of pre-commit or a single hook with the correct stage.delfino
version 3.x
, which requires pydantic>=2.0
.pyupgrade
incorrectly handling minor version number in tool.poetry.dependencies.python
of pyproject.toml
file.git push
if nothing was committed during dependencies-update
.--stash
(default) / --no-stash
option to dependencies-update
command to control whether to stash changes before updating dependencies.local_commands_directory
from delfino
.pyupgrade
into the format
commandtwine
and packaging
.upload-to-pypi
command. No longer needed with Poetry and Packagecloud uses a different upload mechanism.build-docker
command into a new plugin delfino-docker
as docker-build
.Have a look in the pyproject.toml
file. If upload-to-pypi
or build-docker
are listed under tool.delfino.plugins.delfino-core.disable_plugins
, remove them. You don't need to do anything else.
If tool.delfino.plugins.delfino-core.dockerhub
exists in the pyproject.toml
:
delfino-docker
.pyproject.toml
, create a key tool.delfino.plugins.delfino-docker.docker_build
.tool.delfino.plugins.delfino-core.dockerhub
under this new key.username
to dockerhub_username
.upload_to_pypi
and build_docker
extra dependency groups. Missing groups will be simply ignored during installation, so this is not a breaking change.twine
and packaging
in the all
group.dependencies-update
command:
dependencies-update
no longer prints out executed commands since delfino>=0.29.0
logs all executed commands in debug level. Use --log-level debug
to see them.format
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.git-python
is installed after it's use is attempted.poetry
in the dependencies-update
command.dependencies-update
for pipenv
.utils.execute_commands_group
will receive passed arguments as passed_args
from config, if they use the delfino.decorators.pass_args
decorator. Example:
[tool.delfino.plugins.delfino-core.lint-pylint]
pass_args = "--fail-under 0.9"
will pass --fail-under 0.9
to pylint
executed by lint-pylint
, which is in lint
group, which itself is in verify-all
group.utils.execute_commands_group
logs a debug message when a command is not executed because it is disabled.pytest
with extra modules via the tool.delfino.plugins.delfino-core.pytest_modules
config.pytest
with extra modules via tool.delfino.plugins.delfino-core.pytest_modules
config. Each value in this list will prepend pytest
with -m <MODULE NAME>
.lint
command group can be overriden with tool.delfino.plugins.delfino-core.lint_commands
option in the pyproject.toml
file.PYTHONPATH
environment variable in tests.test
, which is the same as test-all
but without coverage.typecheck
will print additional headings if any folders are in a strict mode.test-unit
and test-integration
no longer support the --maxfail
and --debug
flags. Use the passthrough option (any argument after --
) to pass these flags to pytest directly with --maxfail
and -s
respectively.test-all
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.passed_args
.lint
, lint-pylint
, lint-pydocstyle
and lint-pycodestyle
commands takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.--
, which are then passed to the underlying tool:
lint-pycodestyle
lint-pydocstyle
lint-pylint
test-integration
test-unit
typecheck
dependencies-update
and optional dependency group dependencies_update
.build-docker
of cargo
on ARMv7 in emulator.typecheck
no longer accepts an arbitrary list of arguments interpreted as list of files to use. Use -f
/--file
/--folder
instead. This option must be repeated for multiple files/folders.delfino
to allow faster initial development.delfino
.delfino
.All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog
and this project adheres to Semantic Versioning.
Types of changes are:
vcs
/gh
/glab
commands. Now not only trailing special characters are removed but also leading ones and ones around slashes. Example: !breaking: feature / branch.
becomes breaking_feature/branch
.@me
instead of me
as assignee when creating a Gitlab MR using vcs
/glab
pr
/mr
create
/start
commands.vcs
/glab
pr
/mr
create
/start
commands.ruff
in version 0.5.0
has removed support for ruff <path>
syntax and requires ruff check <path>
instead. The ruff
command has been updated to reflect this change, however it will allow this to be overridden by supplying a different action as the extra argument after --
.vcs
/glab
pr
/mr
create
/start
commands.main
in vcs
/gh
/glab
pr
/mr
start
command./
in branch name for vcs
/gh
/glab
commands.vcs
commands. By default, it is set to the git username:
[tool.delfino.plugins.delfino-core]
branch_prefix = "your_prefix/"
glab
that wraps the glab
CLI tool. Similar to the existing gh
command, it has the following subcommands:
glab mr create
glab mr start
glab mr view
vcs
that auto-selects the correct VCS CLI tool in the current directory based on git remote. Currently, gh
and glab
are supported. It has the following subcommands:
vcs pr/mr create
vcs pr/mr start
vcs pr/mr view
PyYAML
when the pre-commit
command is not used.ruff
as an optional dependency in the verify
group.dependencies-update
introduced by update of delfino
.dependencies-update
strips final underscore from the branch name.verify
and dependencies-update
commands with spinners.ruff
. It has been also added to the lint
command group.gh
with additional functionality on top of the gh
CLI tool:
gh pr create
adds sensible defaults for a single developer per branch to ask for almost no input. It also accepts a title of the PR as free text after the commands, as long as it doesn't start with a -
.gh pr start
is a new command, which is like gh pr create
, but also creates a new branch with a name matching the PR title, prefixed with current user's username. This branch is based off latest main and pushed to remote with an empty commit.gh pr view
default to opening the PR in a web browser.dependencies-updates
now correctly defaults to "Yes" if no answer provided.This version renames several commands and command groups to be more consistent and predictable. The intention is to name commands using the same name as the underlying tool. Several commands were also turned into command groups of individual commands, to allow more flexibility in configuration.
Old name | New name |
---|---|
lint-pylint |
pylint |
lint-pydocstyle |
pydocstyle |
lint-pycodestyle |
pycodestyle |
typecheck |
mypy |
test |
pytest |
test-unit |
pytest-unit |
test-integration |
pytest-integration |
verify-all
command group is now called verify
, to match the existing format
and lint
command groups. However, the configration option to override the verify
command group is still tool.delfino.plugins.delfino-core.verify_commands
as it already matched the new name.Affects optional dependencies installed with delfino-core
. Update your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all |
verify |
Affects list of commands visible in given command groups. Update tool.delfino.plugins.delfino-core.<COMMAND_GROUP_NAME>_commans
in your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all_commands |
verify_commands |
This is an implementation detail that should not be relied on, but it's listed here for completeness. Command and command group names were changed to match a pattern run_<COMMAND_NAME>
and run_group_<COMMAND_GROUP_NAME>
. This is to prevent clashes with the names of the underlying tools and easier discoverability.
Old name | New name |
---|---|
coverage_open |
run_coverage_open |
coverage_report |
run_coverage_report |
dependencies_update |
run_dependencies_update |
lint |
run_group_lint |
lint_pycodestyle |
run_pycodestyle |
lint_pydocstyle |
run_pydocstyle |
lint_pylint |
run_pylint |
pre_commit |
run_pre_commit |
run_format |
run_group_format |
switch_python_version |
run_switch_python_version |
test |
run_group_test |
test_all |
run_pytest |
test_integration |
run_pytest_integration |
test_unit |
run_pytest_unit |
typecheck |
run_mypy |
verify_all |
run_group_verify |
ensure-pre-commit
pyupgrade
isort
black
format
command has been turned into a command group of individual.
ensure-pre-commit
, pyupgrade
, isort
and black
.tool.delfino.plugins.delfino-core.format_commands
option in the pyproject.toml
file.test
has been formally changed to a command group (functionally, it was already a group).
pytest
and coverage-report
.tool.delfino.plugins.delfino-core.test_commands
option in the pyproject.toml
file.pre-commit
command to run all stages of pre-commit or a single hook with the correct stage.delfino
version 3.x
, which requires pydantic>=2.0
.pyupgrade
incorrectly handling minor version number in tool.poetry.dependencies.python
of pyproject.toml
file.git push
if nothing was committed during dependencies-update
.--stash
(default) / --no-stash
option to dependencies-update
command to control whether to stash changes before updating dependencies.local_commands_directory
from delfino
.pyupgrade
into the format
commandtwine
and packaging
.upload-to-pypi
command. No longer needed with Poetry and Packagecloud uses a different upload mechanism.build-docker
command into a new plugin delfino-docker
as docker-build
.Have a look in the pyproject.toml
file. If upload-to-pypi
or build-docker
are listed under tool.delfino.plugins.delfino-core.disable_plugins
, remove them. You don't need to do anything else.
If tool.delfino.plugins.delfino-core.dockerhub
exists in the pyproject.toml
:
delfino-docker
.pyproject.toml
, create a key tool.delfino.plugins.delfino-docker.docker_build
.tool.delfino.plugins.delfino-core.dockerhub
under this new key.username
to dockerhub_username
.upload_to_pypi
and build_docker
extra dependency groups. Missing groups will be simply ignored during installation, so this is not a breaking change.twine
and packaging
in the all
group.dependencies-update
command:
dependencies-update
no longer prints out executed commands since delfino>=0.29.0
logs all executed commands in debug level. Use --log-level debug
to see them.format
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.git-python
is installed after it's use is attempted.poetry
in the dependencies-update
command.dependencies-update
for pipenv
.utils.execute_commands_group
will receive passed arguments as passed_args
from config, if they use the delfino.decorators.pass_args
decorator. Example:
[tool.delfino.plugins.delfino-core.lint-pylint]
pass_args = "--fail-under 0.9"
will pass --fail-under 0.9
to pylint
executed by lint-pylint
, which is in lint
group, which itself is in verify-all
group.utils.execute_commands_group
logs a debug message when a command is not executed because it is disabled.pytest
with extra modules via the tool.delfino.plugins.delfino-core.pytest_modules
config.pytest
with extra modules via tool.delfino.plugins.delfino-core.pytest_modules
config. Each value in this list will prepend pytest
with -m <MODULE NAME>
.lint
command group can be overriden with tool.delfino.plugins.delfino-core.lint_commands
option in the pyproject.toml
file.PYTHONPATH
environment variable in tests.test
, which is the same as test-all
but without coverage.typecheck
will print additional headings if any folders are in a strict mode.test-unit
and test-integration
no longer support the --maxfail
and --debug
flags. Use the passthrough option (any argument after --
) to pass these flags to pytest directly with --maxfail
and -s
respectively.test-all
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.passed_args
.lint
, lint-pylint
, lint-pydocstyle
and lint-pycodestyle
commands takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.--
, which are then passed to the underlying tool:
lint-pycodestyle
lint-pydocstyle
lint-pylint
test-integration
test-unit
typecheck
dependencies-update
and optional dependency group dependencies_update
.build-docker
of cargo
on ARMv7 in emulator.typecheck
no longer accepts an arbitrary list of arguments interpreted as list of files to use. Use -f
/--file
/--folder
instead. This option must be repeated for multiple files/folders.delfino
to allow faster initial development.delfino
.delfino
.All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog
and this project adheres to Semantic Versioning.
Types of changes are:
@me
instead of me
as assignee when creating a Gitlab MR using vcs
/glab
pr
/mr
create
/start
commands.vcs
/glab
pr
/mr
create
/start
commands.ruff
in version 0.5.0
has removed support for ruff <path>
syntax and requires ruff check <path>
instead. The ruff
command has been updated to reflect this change, however it will allow this to be overridden by supplying a different action as the extra argument after --
.vcs
/glab
pr
/mr
create
/start
commands.main
in vcs
/gh
/glab
pr
/mr
start
command./
in branch name for vcs
/gh
/glab
commands.vcs
commands. By default, it is set to the git username:
[tool.delfino.plugins.delfino-core]
branch_prefix = "your_prefix/"
glab
that wraps the glab
CLI tool. Similar to the existing gh
command, it has the following subcommands:
glab mr create
glab mr start
glab mr view
vcs
that auto-selects the correct VCS CLI tool in the current directory based on git remote. Currently, gh
and glab
are supported. It has the following subcommands:
vcs pr/mr create
vcs pr/mr start
vcs pr/mr view
PyYAML
when the pre-commit
command is not used.ruff
as an optional dependency in the verify
group.dependencies-update
introduced by update of delfino
.dependencies-update
strips final underscore from the branch name.verify
and dependencies-update
commands with spinners.ruff
. It has been also added to the lint
command group.gh
with additional functionality on top of the gh
CLI tool:
gh pr create
adds sensible defaults for a single developer per branch to ask for almost no input. It also accepts a title of the PR as free text after the commands, as long as it doesn't start with a -
.gh pr start
is a new command, which is like gh pr create
, but also creates a new branch with a name matching the PR title, prefixed with current user's username. This branch is based off latest main and pushed to remote with an empty commit.gh pr view
default to opening the PR in a web browser.dependencies-updates
now correctly defaults to "Yes" if no answer provided.This version renames several commands and command groups to be more consistent and predictable. The intention is to name commands using the same name as the underlying tool. Several commands were also turned into command groups of individual commands, to allow more flexibility in configuration.
Old name | New name |
---|---|
lint-pylint |
pylint |
lint-pydocstyle |
pydocstyle |
lint-pycodestyle |
pycodestyle |
typecheck |
mypy |
test |
pytest |
test-unit |
pytest-unit |
test-integration |
pytest-integration |
verify-all
command group is now called verify
, to match the existing format
and lint
command groups. However, the configration option to override the verify
command group is still tool.delfino.plugins.delfino-core.verify_commands
as it already matched the new name.Affects optional dependencies installed with delfino-core
. Update your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all |
verify |
Affects list of commands visible in given command groups. Update tool.delfino.plugins.delfino-core.<COMMAND_GROUP_NAME>_commans
in your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all_commands |
verify_commands |
This is an implementation detail that should not be relied on, but it's listed here for completeness. Command and command group names were changed to match a pattern run_<COMMAND_NAME>
and run_group_<COMMAND_GROUP_NAME>
. This is to prevent clashes with the names of the underlying tools and easier discoverability.
Old name | New name |
---|---|
coverage_open |
run_coverage_open |
coverage_report |
run_coverage_report |
dependencies_update |
run_dependencies_update |
lint |
run_group_lint |
lint_pycodestyle |
run_pycodestyle |
lint_pydocstyle |
run_pydocstyle |
lint_pylint |
run_pylint |
pre_commit |
run_pre_commit |
run_format |
run_group_format |
switch_python_version |
run_switch_python_version |
test |
run_group_test |
test_all |
run_pytest |
test_integration |
run_pytest_integration |
test_unit |
run_pytest_unit |
typecheck |
run_mypy |
verify_all |
run_group_verify |
ensure-pre-commit
pyupgrade
isort
black
format
command has been turned into a command group of individual.
ensure-pre-commit
, pyupgrade
, isort
and black
.tool.delfino.plugins.delfino-core.format_commands
option in the pyproject.toml
file.test
has been formally changed to a command group (functionally, it was already a group).
pytest
and coverage-report
.tool.delfino.plugins.delfino-core.test_commands
option in the pyproject.toml
file.pre-commit
command to run all stages of pre-commit or a single hook with the correct stage.delfino
version 3.x
, which requires pydantic>=2.0
.pyupgrade
incorrectly handling minor version number in tool.poetry.dependencies.python
of pyproject.toml
file.git push
if nothing was committed during dependencies-update
.--stash
(default) / --no-stash
option to dependencies-update
command to control whether to stash changes before updating dependencies.local_commands_directory
from delfino
.pyupgrade
into the format
commandtwine
and packaging
.upload-to-pypi
command. No longer needed with Poetry and Packagecloud uses a different upload mechanism.build-docker
command into a new plugin delfino-docker
as docker-build
.Have a look in the pyproject.toml
file. If upload-to-pypi
or build-docker
are listed under tool.delfino.plugins.delfino-core.disable_plugins
, remove them. You don't need to do anything else.
If tool.delfino.plugins.delfino-core.dockerhub
exists in the pyproject.toml
:
delfino-docker
.pyproject.toml
, create a key tool.delfino.plugins.delfino-docker.docker_build
.tool.delfino.plugins.delfino-core.dockerhub
under this new key.username
to dockerhub_username
.upload_to_pypi
and build_docker
extra dependency groups. Missing groups will be simply ignored during installation, so this is not a breaking change.twine
and packaging
in the all
group.dependencies-update
command:
dependencies-update
no longer prints out executed commands since delfino>=0.29.0
logs all executed commands in debug level. Use --log-level debug
to see them.format
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.git-python
is installed after it's use is attempted.poetry
in the dependencies-update
command.dependencies-update
for pipenv
.utils.execute_commands_group
will receive passed arguments as passed_args
from config, if they use the delfino.decorators.pass_args
decorator. Example:
[tool.delfino.plugins.delfino-core.lint-pylint]
pass_args = "--fail-under 0.9"
will pass --fail-under 0.9
to pylint
executed by lint-pylint
, which is in lint
group, which itself is in verify-all
group.utils.execute_commands_group
logs a debug message when a command is not executed because it is disabled.pytest
with extra modules via the tool.delfino.plugins.delfino-core.pytest_modules
config.pytest
with extra modules via tool.delfino.plugins.delfino-core.pytest_modules
config. Each value in this list will prepend pytest
with -m <MODULE NAME>
.lint
command group can be overriden with tool.delfino.plugins.delfino-core.lint_commands
option in the pyproject.toml
file.PYTHONPATH
environment variable in tests.test
, which is the same as test-all
but without coverage.typecheck
will print additional headings if any folders are in a strict mode.test-unit
and test-integration
no longer support the --maxfail
and --debug
flags. Use the passthrough option (any argument after --
) to pass these flags to pytest directly with --maxfail
and -s
respectively.test-all
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.passed_args
.lint
, lint-pylint
, lint-pydocstyle
and lint-pycodestyle
commands takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.--
, which are then passed to the underlying tool:
lint-pycodestyle
lint-pydocstyle
lint-pylint
test-integration
test-unit
typecheck
dependencies-update
and optional dependency group dependencies_update
.build-docker
of cargo
on ARMv7 in emulator.typecheck
no longer accepts an arbitrary list of arguments interpreted as list of files to use. Use -f
/--file
/--folder
instead. This option must be repeated for multiple files/folders.delfino
to allow faster initial development.delfino
.delfino
.All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog
and this project adheres to Semantic Versioning.
Types of changes are:
vcs
/glab
pr
/mr
create
/start
commands.ruff
in version 0.5.0
has removed support for ruff <path>
syntax and requires ruff check <path>
instead. The ruff
command has been updated to reflect this change, however it will allow this to be overridden by supplying a different action as the extra argument after --
.vcs
/glab
pr
/mr
create
/start
commands.main
in vcs
/gh
/glab
pr
/mr
start
command./
in branch name for vcs
/gh
/glab
commands.vcs
commands. By default, it is set to the git username:
[tool.delfino.plugins.delfino-core]
branch_prefix = "your_prefix/"
glab
that wraps the glab
CLI tool. Similar to the existing gh
command, it has the following subcommands:
glab mr create
glab mr start
glab mr view
vcs
that auto-selects the correct VCS CLI tool in the current directory based on git remote. Currently, gh
and glab
are supported. It has the following subcommands:
vcs pr/mr create
vcs pr/mr start
vcs pr/mr view
PyYAML
when the pre-commit
command is not used.ruff
as an optional dependency in the verify
group.dependencies-update
introduced by update of delfino
.dependencies-update
strips final underscore from the branch name.verify
and dependencies-update
commands with spinners.ruff
. It has been also added to the lint
command group.gh
with additional functionality on top of the gh
CLI tool:
gh pr create
adds sensible defaults for a single developer per branch to ask for almost no input. It also accepts a title of the PR as free text after the commands, as long as it doesn't start with a -
.gh pr start
is a new command, which is like gh pr create
, but also creates a new branch with a name matching the PR title, prefixed with current user's username. This branch is based off latest main and pushed to remote with an empty commit.gh pr view
default to opening the PR in a web browser.dependencies-updates
now correctly defaults to "Yes" if no answer provided.This version renames several commands and command groups to be more consistent and predictable. The intention is to name commands using the same name as the underlying tool. Several commands were also turned into command groups of individual commands, to allow more flexibility in configuration.
Old name | New name |
---|---|
lint-pylint |
pylint |
lint-pydocstyle |
pydocstyle |
lint-pycodestyle |
pycodestyle |
typecheck |
mypy |
test |
pytest |
test-unit |
pytest-unit |
test-integration |
pytest-integration |
verify-all
command group is now called verify
, to match the existing format
and lint
command groups. However, the configration option to override the verify
command group is still tool.delfino.plugins.delfino-core.verify_commands
as it already matched the new name.Affects optional dependencies installed with delfino-core
. Update your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all |
verify |
Affects list of commands visible in given command groups. Update tool.delfino.plugins.delfino-core.<COMMAND_GROUP_NAME>_commans
in your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all_commands |
verify_commands |
This is an implementation detail that should not be relied on, but it's listed here for completeness. Command and command group names were changed to match a pattern run_<COMMAND_NAME>
and run_group_<COMMAND_GROUP_NAME>
. This is to prevent clashes with the names of the underlying tools and easier discoverability.
Old name | New name |
---|---|
coverage_open |
run_coverage_open |
coverage_report |
run_coverage_report |
dependencies_update |
run_dependencies_update |
lint |
run_group_lint |
lint_pycodestyle |
run_pycodestyle |
lint_pydocstyle |
run_pydocstyle |
lint_pylint |
run_pylint |
pre_commit |
run_pre_commit |
run_format |
run_group_format |
switch_python_version |
run_switch_python_version |
test |
run_group_test |
test_all |
run_pytest |
test_integration |
run_pytest_integration |
test_unit |
run_pytest_unit |
typecheck |
run_mypy |
verify_all |
run_group_verify |
ensure-pre-commit
pyupgrade
isort
black
format
command has been turned into a command group of individual.
ensure-pre-commit
, pyupgrade
, isort
and black
.tool.delfino.plugins.delfino-core.format_commands
option in the pyproject.toml
file.test
has been formally changed to a command group (functionally, it was already a group).
pytest
and coverage-report
.tool.delfino.plugins.delfino-core.test_commands
option in the pyproject.toml
file.pre-commit
command to run all stages of pre-commit or a single hook with the correct stage.delfino
version 3.x
, which requires pydantic>=2.0
.pyupgrade
incorrectly handling minor version number in tool.poetry.dependencies.python
of pyproject.toml
file.git push
if nothing was committed during dependencies-update
.--stash
(default) / --no-stash
option to dependencies-update
command to control whether to stash changes before updating dependencies.local_commands_directory
from delfino
.pyupgrade
into the format
commandtwine
and packaging
.upload-to-pypi
command. No longer needed with Poetry and Packagecloud uses a different upload mechanism.build-docker
command into a new plugin delfino-docker
as docker-build
.Have a look in the pyproject.toml
file. If upload-to-pypi
or build-docker
are listed under tool.delfino.plugins.delfino-core.disable_plugins
, remove them. You don't need to do anything else.
If tool.delfino.plugins.delfino-core.dockerhub
exists in the pyproject.toml
:
delfino-docker
.pyproject.toml
, create a key tool.delfino.plugins.delfino-docker.docker_build
.tool.delfino.plugins.delfino-core.dockerhub
under this new key.username
to dockerhub_username
.upload_to_pypi
and build_docker
extra dependency groups. Missing groups will be simply ignored during installation, so this is not a breaking change.twine
and packaging
in the all
group.dependencies-update
command:
dependencies-update
no longer prints out executed commands since delfino>=0.29.0
logs all executed commands in debug level. Use --log-level debug
to see them.format
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.git-python
is installed after it's use is attempted.poetry
in the dependencies-update
command.dependencies-update
for pipenv
.utils.execute_commands_group
will receive passed arguments as passed_args
from config, if they use the delfino.decorators.pass_args
decorator. Example:
[tool.delfino.plugins.delfino-core.lint-pylint]
pass_args = "--fail-under 0.9"
will pass --fail-under 0.9
to pylint
executed by lint-pylint
, which is in lint
group, which itself is in verify-all
group.utils.execute_commands_group
logs a debug message when a command is not executed because it is disabled.pytest
with extra modules via the tool.delfino.plugins.delfino-core.pytest_modules
config.pytest
with extra modules via tool.delfino.plugins.delfino-core.pytest_modules
config. Each value in this list will prepend pytest
with -m <MODULE NAME>
.lint
command group can be overriden with tool.delfino.plugins.delfino-core.lint_commands
option in the pyproject.toml
file.PYTHONPATH
environment variable in tests.test
, which is the same as test-all
but without coverage.typecheck
will print additional headings if any folders are in a strict mode.test-unit
and test-integration
no longer support the --maxfail
and --debug
flags. Use the passthrough option (any argument after --
) to pass these flags to pytest directly with --maxfail
and -s
respectively.test-all
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.passed_args
.lint
, lint-pylint
, lint-pydocstyle
and lint-pycodestyle
commands takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.--
, which are then passed to the underlying tool:
lint-pycodestyle
lint-pydocstyle
lint-pylint
test-integration
test-unit
typecheck
dependencies-update
and optional dependency group dependencies_update
.build-docker
of cargo
on ARMv7 in emulator.typecheck
no longer accepts an arbitrary list of arguments interpreted as list of files to use. Use -f
/--file
/--folder
instead. This option must be repeated for multiple files/folders.delfino
to allow faster initial development.delfino
.delfino
.All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog
and this project adheres to Semantic Versioning.
Types of changes are:
ruff
in version 0.5.0
has removed support for ruff <path>
syntax and requires ruff check <path>
instead. The ruff
command has been updated to reflect this change, however it will allow this to be overridden by supplying a different action as the extra argument after --
.vcs
/glab
pr
/mr
create
/start
commands.main
in vcs
/gh
/glab
pr
/mr
start
command./
in branch name for vcs
/gh
/glab
commands.vcs
commands. By default, it is set to the git username:
[tool.delfino.plugins.delfino-core]
branch_prefix = "your_prefix/"
glab
that wraps the glab
CLI tool. Similar to the existing gh
command, it has the following subcommands:
glab mr create
glab mr start
glab mr view
vcs
that auto-selects the correct VCS CLI tool in the current directory based on git remote. Currently, gh
and glab
are supported. It has the following subcommands:
vcs pr/mr create
vcs pr/mr start
vcs pr/mr view
PyYAML
when the pre-commit
command is not used.ruff
as an optional dependency in the verify
group.dependencies-update
introduced by update of delfino
.dependencies-update
strips final underscore from the branch name.verify
and dependencies-update
commands with spinners.ruff
. It has been also added to the lint
command group.gh
with additional functionality on top of the gh
CLI tool:
gh pr create
adds sensible defaults for a single developer per branch to ask for almost no input. It also accepts a title of the PR as free text after the commands, as long as it doesn't start with a -
.gh pr start
is a new command, which is like gh pr create
, but also creates a new branch with a name matching the PR title, prefixed with current user's username. This branch is based off latest main and pushed to remote with an empty commit.gh pr view
default to opening the PR in a web browser.dependencies-updates
now correctly defaults to "Yes" if no answer provided.This version renames several commands and command groups to be more consistent and predictable. The intention is to name commands using the same name as the underlying tool. Several commands were also turned into command groups of individual commands, to allow more flexibility in configuration.
Old name | New name |
---|---|
lint-pylint |
pylint |
lint-pydocstyle |
pydocstyle |
lint-pycodestyle |
pycodestyle |
typecheck |
mypy |
test |
pytest |
test-unit |
pytest-unit |
test-integration |
pytest-integration |
verify-all
command group is now called verify
, to match the existing format
and lint
command groups. However, the configration option to override the verify
command group is still tool.delfino.plugins.delfino-core.verify_commands
as it already matched the new name.Affects optional dependencies installed with delfino-core
. Update your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all |
verify |
Affects list of commands visible in given command groups. Update tool.delfino.plugins.delfino-core.<COMMAND_GROUP_NAME>_commans
in your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all_commands |
verify_commands |
This is an implementation detail that should not be relied on, but it's listed here for completeness. Command and command group names were changed to match a pattern run_<COMMAND_NAME>
and run_group_<COMMAND_GROUP_NAME>
. This is to prevent clashes with the names of the underlying tools and easier discoverability.
Old name | New name |
---|---|
coverage_open |
run_coverage_open |
coverage_report |
run_coverage_report |
dependencies_update |
run_dependencies_update |
lint |
run_group_lint |
lint_pycodestyle |
run_pycodestyle |
lint_pydocstyle |
run_pydocstyle |
lint_pylint |
run_pylint |
pre_commit |
run_pre_commit |
run_format |
run_group_format |
switch_python_version |
run_switch_python_version |
test |
run_group_test |
test_all |
run_pytest |
test_integration |
run_pytest_integration |
test_unit |
run_pytest_unit |
typecheck |
run_mypy |
verify_all |
run_group_verify |
ensure-pre-commit
pyupgrade
isort
black
format
command has been turned into a command group of individual.
ensure-pre-commit
, pyupgrade
, isort
and black
.tool.delfino.plugins.delfino-core.format_commands
option in the pyproject.toml
file.test
has been formally changed to a command group (functionally, it was already a group).
pytest
and coverage-report
.tool.delfino.plugins.delfino-core.test_commands
option in the pyproject.toml
file.pre-commit
command to run all stages of pre-commit or a single hook with the correct stage.delfino
version 3.x
, which requires pydantic>=2.0
.pyupgrade
incorrectly handling minor version number in tool.poetry.dependencies.python
of pyproject.toml
file.git push
if nothing was committed during dependencies-update
.--stash
(default) / --no-stash
option to dependencies-update
command to control whether to stash changes before updating dependencies.local_commands_directory
from delfino
.pyupgrade
into the format
commandtwine
and packaging
.upload-to-pypi
command. No longer needed with Poetry and Packagecloud uses a different upload mechanism.build-docker
command into a new plugin delfino-docker
as docker-build
.Have a look in the pyproject.toml
file. If upload-to-pypi
or build-docker
are listed under tool.delfino.plugins.delfino-core.disable_plugins
, remove them. You don't need to do anything else.
If tool.delfino.plugins.delfino-core.dockerhub
exists in the pyproject.toml
:
delfino-docker
.pyproject.toml
, create a key tool.delfino.plugins.delfino-docker.docker_build
.tool.delfino.plugins.delfino-core.dockerhub
under this new key.username
to dockerhub_username
.upload_to_pypi
and build_docker
extra dependency groups. Missing groups will be simply ignored during installation, so this is not a breaking change.twine
and packaging
in the all
group.dependencies-update
command:
dependencies-update
no longer prints out executed commands since delfino>=0.29.0
logs all executed commands in debug level. Use --log-level debug
to see them.format
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.git-python
is installed after it's use is attempted.poetry
in the dependencies-update
command.dependencies-update
for pipenv
.utils.execute_commands_group
will receive passed arguments as passed_args
from config, if they use the delfino.decorators.pass_args
decorator. Example:
[tool.delfino.plugins.delfino-core.lint-pylint]
pass_args = "--fail-under 0.9"
will pass --fail-under 0.9
to pylint
executed by lint-pylint
, which is in lint
group, which itself is in verify-all
group.utils.execute_commands_group
logs a debug message when a command is not executed because it is disabled.pytest
with extra modules via the tool.delfino.plugins.delfino-core.pytest_modules
config.pytest
with extra modules via tool.delfino.plugins.delfino-core.pytest_modules
config. Each value in this list will prepend pytest
with -m <MODULE NAME>
.lint
command group can be overriden with tool.delfino.plugins.delfino-core.lint_commands
option in the pyproject.toml
file.PYTHONPATH
environment variable in tests.test
, which is the same as test-all
but without coverage.typecheck
will print additional headings if any folders are in a strict mode.test-unit
and test-integration
no longer support the --maxfail
and --debug
flags. Use the passthrough option (any argument after --
) to pass these flags to pytest directly with --maxfail
and -s
respectively.test-all
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.passed_args
.lint
, lint-pylint
, lint-pydocstyle
and lint-pycodestyle
commands takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.--
, which are then passed to the underlying tool:
lint-pycodestyle
lint-pydocstyle
lint-pylint
test-integration
test-unit
typecheck
dependencies-update
and optional dependency group dependencies_update
.build-docker
of cargo
on ARMv7 in emulator.typecheck
no longer accepts an arbitrary list of arguments interpreted as list of files to use. Use -f
/--file
/--folder
instead. This option must be repeated for multiple files/folders.delfino
to allow faster initial development.delfino
.delfino
.All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog
and this project adheres to Semantic Versioning.
Types of changes are:
vcs
/glab
pr
/mr
create
/start
commands.main
in vcs
/gh
/glab
pr
/mr
start
command./
in branch name for vcs
/gh
/glab
commands.vcs
commands. By default, it is set to the git username:
[tool.delfino.plugins.delfino-core]
branch_prefix = "your_prefix/"
glab
that wraps the glab
CLI tool. Similar to the existing gh
command, it has the following subcommands:
glab mr create
glab mr start
glab mr view
vcs
that auto-selects the correct VCS CLI tool in the current directory based on git remote. Currently, gh
and glab
are supported. It has the following subcommands:
vcs pr/mr create
vcs pr/mr start
vcs pr/mr view
PyYAML
when the pre-commit
command is not used.ruff
as an optional dependency in the verify
group.dependencies-update
introduced by update of delfino
.dependencies-update
strips final underscore from the branch name.verify
and dependencies-update
commands with spinners.ruff
. It has been also added to the lint
command group.gh
with additional functionality on top of the gh
CLI tool:
gh pr create
adds sensible defaults for a single developer per branch to ask for almost no input. It also accepts a title of the PR as free text after the commands, as long as it doesn't start with a -
.gh pr start
is a new command, which is like gh pr create
, but also creates a new branch with a name matching the PR title, prefixed with current user's username. This branch is based off latest main and pushed to remote with an empty commit.gh pr view
default to opening the PR in a web browser.dependencies-updates
now correctly defaults to "Yes" if no answer provided.This version renames several commands and command groups to be more consistent and predictable. The intention is to name commands using the same name as the underlying tool. Several commands were also turned into command groups of individual commands, to allow more flexibility in configuration.
Old name | New name |
---|---|
lint-pylint |
pylint |
lint-pydocstyle |
pydocstyle |
lint-pycodestyle |
pycodestyle |
typecheck |
mypy |
test |
pytest |
test-unit |
pytest-unit |
test-integration |
pytest-integration |
verify-all
command group is now called verify
, to match the existing format
and lint
command groups. However, the configration option to override the verify
command group is still tool.delfino.plugins.delfino-core.verify_commands
as it already matched the new name.Affects optional dependencies installed with delfino-core
. Update your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all |
verify |
Affects list of commands visible in given command groups. Update tool.delfino.plugins.delfino-core.<COMMAND_GROUP_NAME>_commans
in your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all_commands |
verify_commands |
This is an implementation detail that should not be relied on, but it's listed here for completeness. Command and command group names were changed to match a pattern run_<COMMAND_NAME>
and run_group_<COMMAND_GROUP_NAME>
. This is to prevent clashes with the names of the underlying tools and easier discoverability.
Old name | New name |
---|---|
coverage_open |
run_coverage_open |
coverage_report |
run_coverage_report |
dependencies_update |
run_dependencies_update |
lint |
run_group_lint |
lint_pycodestyle |
run_pycodestyle |
lint_pydocstyle |
run_pydocstyle |
lint_pylint |
run_pylint |
pre_commit |
run_pre_commit |
run_format |
run_group_format |
switch_python_version |
run_switch_python_version |
test |
run_group_test |
test_all |
run_pytest |
test_integration |
run_pytest_integration |
test_unit |
run_pytest_unit |
typecheck |
run_mypy |
verify_all |
run_group_verify |
ensure-pre-commit
pyupgrade
isort
black
format
command has been turned into a command group of individual.
ensure-pre-commit
, pyupgrade
, isort
and black
.tool.delfino.plugins.delfino-core.format_commands
option in the pyproject.toml
file.test
has been formally changed to a command group (functionally, it was already a group).
pytest
and coverage-report
.tool.delfino.plugins.delfino-core.test_commands
option in the pyproject.toml
file.pre-commit
command to run all stages of pre-commit or a single hook with the correct stage.delfino
version 3.x
, which requires pydantic>=2.0
.pyupgrade
incorrectly handling minor version number in tool.poetry.dependencies.python
of pyproject.toml
file.git push
if nothing was committed during dependencies-update
.--stash
(default) / --no-stash
option to dependencies-update
command to control whether to stash changes before updating dependencies.local_commands_directory
from delfino
.pyupgrade
into the format
commandtwine
and packaging
.upload-to-pypi
command. No longer needed with Poetry and Packagecloud uses a different upload mechanism.build-docker
command into a new plugin delfino-docker
as docker-build
.Have a look in the pyproject.toml
file. If upload-to-pypi
or build-docker
are listed under tool.delfino.plugins.delfino-core.disable_plugins
, remove them. You don't need to do anything else.
If tool.delfino.plugins.delfino-core.dockerhub
exists in the pyproject.toml
:
delfino-docker
.pyproject.toml
, create a key tool.delfino.plugins.delfino-docker.docker_build
.tool.delfino.plugins.delfino-core.dockerhub
under this new key.username
to dockerhub_username
.upload_to_pypi
and build_docker
extra dependency groups. Missing groups will be simply ignored during installation, so this is not a breaking change.twine
and packaging
in the all
group.dependencies-update
command:
dependencies-update
no longer prints out executed commands since delfino>=0.29.0
logs all executed commands in debug level. Use --log-level debug
to see them.format
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.git-python
is installed after it's use is attempted.poetry
in the dependencies-update
command.dependencies-update
for pipenv
.utils.execute_commands_group
will receive passed arguments as passed_args
from config, if they use the delfino.decorators.pass_args
decorator. Example:
[tool.delfino.plugins.delfino-core.lint-pylint]
pass_args = "--fail-under 0.9"
will pass --fail-under 0.9
to pylint
executed by lint-pylint
, which is in lint
group, which itself is in verify-all
group.utils.execute_commands_group
logs a debug message when a command is not executed because it is disabled.pytest
with extra modules via the tool.delfino.plugins.delfino-core.pytest_modules
config.pytest
with extra modules via tool.delfino.plugins.delfino-core.pytest_modules
config. Each value in this list will prepend pytest
with -m <MODULE NAME>
.lint
command group can be overriden with tool.delfino.plugins.delfino-core.lint_commands
option in the pyproject.toml
file.PYTHONPATH
environment variable in tests.test
, which is the same as test-all
but without coverage.typecheck
will print additional headings if any folders are in a strict mode.test-unit
and test-integration
no longer support the --maxfail
and --debug
flags. Use the passthrough option (any argument after --
) to pass these flags to pytest directly with --maxfail
and -s
respectively.test-all
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.passed_args
.lint
, lint-pylint
, lint-pydocstyle
and lint-pycodestyle
commands takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.--
, which are then passed to the underlying tool:
lint-pycodestyle
lint-pydocstyle
lint-pylint
test-integration
test-unit
typecheck
dependencies-update
and optional dependency group dependencies_update
.build-docker
of cargo
on ARMv7 in emulator.typecheck
no longer accepts an arbitrary list of arguments interpreted as list of files to use. Use -f
/--file
/--folder
instead. This option must be repeated for multiple files/folders.delfino
to allow faster initial development.delfino
.delfino
.All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog
and this project adheres to Semantic Versioning.
Types of changes are:
main
in vcs
/gh
/glab
pr
/mr
start
command./
in branch name for vcs
/gh
/glab
commands.vcs
commands. By default, it is set to the git username:
[tool.delfino.plugins.delfino-core]
branch_prefix = "your_prefix/"
glab
that wraps the glab
CLI tool. Similar to the existing gh
command, it has the following subcommands:
glab mr create
glab mr start
glab mr view
vcs
that auto-selects the correct VCS CLI tool in the current directory based on git remote. Currently, gh
and glab
are supported. It has the following subcommands:
vcs pr/mr create
vcs pr/mr start
vcs pr/mr view
PyYAML
when the pre-commit
command is not used.ruff
as an optional dependency in the verify
group.dependencies-update
introduced by update of delfino
.dependencies-update
strips final underscore from the branch name.verify
and dependencies-update
commands with spinners.ruff
. It has been also added to the lint
command group.gh
with additional functionality on top of the gh
CLI tool:
gh pr create
adds sensible defaults for a single developer per branch to ask for almost no input. It also accepts a title of the PR as free text after the commands, as long as it doesn't start with a -
.gh pr start
is a new command, which is like gh pr create
, but also creates a new branch with a name matching the PR title, prefixed with current user's username. This branch is based off latest main and pushed to remote with an empty commit.gh pr view
default to opening the PR in a web browser.dependencies-updates
now correctly defaults to "Yes" if no answer provided.This version renames several commands and command groups to be more consistent and predictable. The intention is to name commands using the same name as the underlying tool. Several commands were also turned into command groups of individual commands, to allow more flexibility in configuration.
Old name | New name |
---|---|
lint-pylint |
pylint |
lint-pydocstyle |
pydocstyle |
lint-pycodestyle |
pycodestyle |
typecheck |
mypy |
test |
pytest |
test-unit |
pytest-unit |
test-integration |
pytest-integration |
verify-all
command group is now called verify
, to match the existing format
and lint
command groups. However, the configration option to override the verify
command group is still tool.delfino.plugins.delfino-core.verify_commands
as it already matched the new name.Affects optional dependencies installed with delfino-core
. Update your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all |
verify |
Affects list of commands visible in given command groups. Update tool.delfino.plugins.delfino-core.<COMMAND_GROUP_NAME>_commans
in your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all_commands |
verify_commands |
This is an implementation detail that should not be relied on, but it's listed here for completeness. Command and command group names were changed to match a pattern run_<COMMAND_NAME>
and run_group_<COMMAND_GROUP_NAME>
. This is to prevent clashes with the names of the underlying tools and easier discoverability.
Old name | New name |
---|---|
coverage_open |
run_coverage_open |
coverage_report |
run_coverage_report |
dependencies_update |
run_dependencies_update |
lint |
run_group_lint |
lint_pycodestyle |
run_pycodestyle |
lint_pydocstyle |
run_pydocstyle |
lint_pylint |
run_pylint |
pre_commit |
run_pre_commit |
run_format |
run_group_format |
switch_python_version |
run_switch_python_version |
test |
run_group_test |
test_all |
run_pytest |
test_integration |
run_pytest_integration |
test_unit |
run_pytest_unit |
typecheck |
run_mypy |
verify_all |
run_group_verify |
ensure-pre-commit
pyupgrade
isort
black
format
command has been turned into a command group of individual.
ensure-pre-commit
, pyupgrade
, isort
and black
.tool.delfino.plugins.delfino-core.format_commands
option in the pyproject.toml
file.test
has been formally changed to a command group (functionally, it was already a group).
pytest
and coverage-report
.tool.delfino.plugins.delfino-core.test_commands
option in the pyproject.toml
file.pre-commit
command to run all stages of pre-commit or a single hook with the correct stage.delfino
version 3.x
, which requires pydantic>=2.0
.pyupgrade
incorrectly handling minor version number in tool.poetry.dependencies.python
of pyproject.toml
file.git push
if nothing was committed during dependencies-update
.--stash
(default) / --no-stash
option to dependencies-update
command to control whether to stash changes before updating dependencies.local_commands_directory
from delfino
.pyupgrade
into the format
commandtwine
and packaging
.upload-to-pypi
command. No longer needed with Poetry and Packagecloud uses a different upload mechanism.build-docker
command into a new plugin delfino-docker
as docker-build
.Have a look in the pyproject.toml
file. If upload-to-pypi
or build-docker
are listed under tool.delfino.plugins.delfino-core.disable_plugins
, remove them. You don't need to do anything else.
If tool.delfino.plugins.delfino-core.dockerhub
exists in the pyproject.toml
:
delfino-docker
.pyproject.toml
, create a key tool.delfino.plugins.delfino-docker.docker_build
.tool.delfino.plugins.delfino-core.dockerhub
under this new key.username
to dockerhub_username
.upload_to_pypi
and build_docker
extra dependency groups. Missing groups will be simply ignored during installation, so this is not a breaking change.twine
and packaging
in the all
group.dependencies-update
command:
dependencies-update
no longer prints out executed commands since delfino>=0.29.0
logs all executed commands in debug level. Use --log-level debug
to see them.format
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.git-python
is installed after it's use is attempted.poetry
in the dependencies-update
command.dependencies-update
for pipenv
.utils.execute_commands_group
will receive passed arguments as passed_args
from config, if they use the delfino.decorators.pass_args
decorator. Example:
[tool.delfino.plugins.delfino-core.lint-pylint]
pass_args = "--fail-under 0.9"
will pass --fail-under 0.9
to pylint
executed by lint-pylint
, which is in lint
group, which itself is in verify-all
group.utils.execute_commands_group
logs a debug message when a command is not executed because it is disabled.pytest
with extra modules via the tool.delfino.plugins.delfino-core.pytest_modules
config.pytest
with extra modules via tool.delfino.plugins.delfino-core.pytest_modules
config. Each value in this list will prepend pytest
with -m <MODULE NAME>
.lint
command group can be overriden with tool.delfino.plugins.delfino-core.lint_commands
option in the pyproject.toml
file.PYTHONPATH
environment variable in tests.test
, which is the same as test-all
but without coverage.typecheck
will print additional headings if any folders are in a strict mode.test-unit
and test-integration
no longer support the --maxfail
and --debug
flags. Use the passthrough option (any argument after --
) to pass these flags to pytest directly with --maxfail
and -s
respectively.test-all
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.passed_args
.lint
, lint-pylint
, lint-pydocstyle
and lint-pycodestyle
commands takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.--
, which are then passed to the underlying tool:
lint-pycodestyle
lint-pydocstyle
lint-pylint
test-integration
test-unit
typecheck
dependencies-update
and optional dependency group dependencies_update
.build-docker
of cargo
on ARMv7 in emulator.typecheck
no longer accepts an arbitrary list of arguments interpreted as list of files to use. Use -f
/--file
/--folder
instead. This option must be repeated for multiple files/folders.delfino
to allow faster initial development.delfino
.delfino
.All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog
and this project adheres to Semantic Versioning.
Types of changes are:
/
in branch name for vcs
/gh
/glab
commands.vcs
commands. By default, it is set to the git username:
[tool.delfino.plugins.delfino-core]
branch_prefix = "your_prefix/"
glab
that wraps the glab
CLI tool. Similar to the existing gh
command, it has the following subcommands:
glab mr create
glab mr start
glab mr view
vcs
that auto-selects the correct VCS CLI tool in the current directory based on git remote. Currently, gh
and glab
are supported. It has the following subcommands:
vcs pr/mr create
vcs pr/mr start
vcs pr/mr view
PyYAML
when the pre-commit
command is not used.ruff
as an optional dependency in the verify
group.dependencies-update
introduced by update of delfino
.dependencies-update
strips final underscore from the branch name.verify
and dependencies-update
commands with spinners.ruff
. It has been also added to the lint
command group.gh
with additional functionality on top of the gh
CLI tool:
gh pr create
adds sensible defaults for a single developer per branch to ask for almost no input. It also accepts a title of the PR as free text after the commands, as long as it doesn't start with a -
.gh pr start
is a new command, which is like gh pr create
, but also creates a new branch with a name matching the PR title, prefixed with current user's username. This branch is based off latest main and pushed to remote with an empty commit.gh pr view
default to opening the PR in a web browser.dependencies-updates
now correctly defaults to "Yes" if no answer provided.This version renames several commands and command groups to be more consistent and predictable. The intention is to name commands using the same name as the underlying tool. Several commands were also turned into command groups of individual commands, to allow more flexibility in configuration.
Old name | New name |
---|---|
lint-pylint |
pylint |
lint-pydocstyle |
pydocstyle |
lint-pycodestyle |
pycodestyle |
typecheck |
mypy |
test |
pytest |
test-unit |
pytest-unit |
test-integration |
pytest-integration |
verify-all
command group is now called verify
, to match the existing format
and lint
command groups. However, the configration option to override the verify
command group is still tool.delfino.plugins.delfino-core.verify_commands
as it already matched the new name.Affects optional dependencies installed with delfino-core
. Update your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all |
verify |
Affects list of commands visible in given command groups. Update tool.delfino.plugins.delfino-core.<COMMAND_GROUP_NAME>_commans
in your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all_commands |
verify_commands |
This is an implementation detail that should not be relied on, but it's listed here for completeness. Command and command group names were changed to match a pattern run_<COMMAND_NAME>
and run_group_<COMMAND_GROUP_NAME>
. This is to prevent clashes with the names of the underlying tools and easier discoverability.
Old name | New name |
---|---|
coverage_open |
run_coverage_open |
coverage_report |
run_coverage_report |
dependencies_update |
run_dependencies_update |
lint |
run_group_lint |
lint_pycodestyle |
run_pycodestyle |
lint_pydocstyle |
run_pydocstyle |
lint_pylint |
run_pylint |
pre_commit |
run_pre_commit |
run_format |
run_group_format |
switch_python_version |
run_switch_python_version |
test |
run_group_test |
test_all |
run_pytest |
test_integration |
run_pytest_integration |
test_unit |
run_pytest_unit |
typecheck |
run_mypy |
verify_all |
run_group_verify |
ensure-pre-commit
pyupgrade
isort
black
format
command has been turned into a command group of individual.
ensure-pre-commit
, pyupgrade
, isort
and black
.tool.delfino.plugins.delfino-core.format_commands
option in the pyproject.toml
file.test
has been formally changed to a command group (functionally, it was already a group).
pytest
and coverage-report
.tool.delfino.plugins.delfino-core.test_commands
option in the pyproject.toml
file.pre-commit
command to run all stages of pre-commit or a single hook with the correct stage.delfino
version 3.x
, which requires pydantic>=2.0
.pyupgrade
incorrectly handling minor version number in tool.poetry.dependencies.python
of pyproject.toml
file.git push
if nothing was committed during dependencies-update
.--stash
(default) / --no-stash
option to dependencies-update
command to control whether to stash changes before updating dependencies.local_commands_directory
from delfino
.pyupgrade
into the format
commandtwine
and packaging
.upload-to-pypi
command. No longer needed with Poetry and Packagecloud uses a different upload mechanism.build-docker
command into a new plugin delfino-docker
as docker-build
.Have a look in the pyproject.toml
file. If upload-to-pypi
or build-docker
are listed under tool.delfino.plugins.delfino-core.disable_plugins
, remove them. You don't need to do anything else.
If tool.delfino.plugins.delfino-core.dockerhub
exists in the pyproject.toml
:
delfino-docker
.pyproject.toml
, create a key tool.delfino.plugins.delfino-docker.docker_build
.tool.delfino.plugins.delfino-core.dockerhub
under this new key.username
to dockerhub_username
.upload_to_pypi
and build_docker
extra dependency groups. Missing groups will be simply ignored during installation, so this is not a breaking change.twine
and packaging
in the all
group.dependencies-update
command:
dependencies-update
no longer prints out executed commands since delfino>=0.29.0
logs all executed commands in debug level. Use --log-level debug
to see them.format
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.git-python
is installed after it's use is attempted.poetry
in the dependencies-update
command.dependencies-update
for pipenv
.utils.execute_commands_group
will receive passed arguments as passed_args
from config, if they use the delfino.decorators.pass_args
decorator. Example:
[tool.delfino.plugins.delfino-core.lint-pylint]
pass_args = "--fail-under 0.9"
will pass --fail-under 0.9
to pylint
executed by lint-pylint
, which is in lint
group, which itself is in verify-all
group.utils.execute_commands_group
logs a debug message when a command is not executed because it is disabled.pytest
with extra modules via the tool.delfino.plugins.delfino-core.pytest_modules
config.pytest
with extra modules via tool.delfino.plugins.delfino-core.pytest_modules
config. Each value in this list will prepend pytest
with -m <MODULE NAME>
.lint
command group can be overriden with tool.delfino.plugins.delfino-core.lint_commands
option in the pyproject.toml
file.PYTHONPATH
environment variable in tests.test
, which is the same as test-all
but without coverage.typecheck
will print additional headings if any folders are in a strict mode.test-unit
and test-integration
no longer support the --maxfail
and --debug
flags. Use the passthrough option (any argument after --
) to pass these flags to pytest directly with --maxfail
and -s
respectively.test-all
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.passed_args
.lint
, lint-pylint
, lint-pydocstyle
and lint-pycodestyle
commands takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.--
, which are then passed to the underlying tool:
lint-pycodestyle
lint-pydocstyle
lint-pylint
test-integration
test-unit
typecheck
dependencies-update
and optional dependency group dependencies_update
.build-docker
of cargo
on ARMv7 in emulator.typecheck
no longer accepts an arbitrary list of arguments interpreted as list of files to use. Use -f
/--file
/--folder
instead. This option must be repeated for multiple files/folders.delfino
to allow faster initial development.delfino
.delfino
.All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog
and this project adheres to Semantic Versioning.
Types of changes are:
vcs
commands. By default, it is set to the git username:
[tool.delfino.plugins.delfino-core]
branch_prefix = "your_prefix/"
glab
that wraps the glab
CLI tool. Similar to the existing gh
command, it has the following subcommands:
glab mr create
glab mr start
glab mr view
vcs
that auto-selects the correct VCS CLI tool in the current directory based on git remote. Currently, gh
and glab
are supported. It has the following subcommands:
vcs pr/mr create
vcs pr/mr start
vcs pr/mr view
PyYAML
when the pre-commit
command is not used.ruff
as an optional dependency in the verify
group.dependencies-update
introduced by update of delfino
.dependencies-update
strips final underscore from the branch name.verify
and dependencies-update
commands with spinners.ruff
. It has been also added to the lint
command group.gh
with additional functionality on top of the gh
CLI tool:
gh pr create
adds sensible defaults for a single developer per branch to ask for almost no input. It also accepts a title of the PR as free text after the commands, as long as it doesn't start with a -
.gh pr start
is a new command, which is like gh pr create
, but also creates a new branch with a name matching the PR title, prefixed with current user's username. This branch is based off latest main and pushed to remote with an empty commit.gh pr view
default to opening the PR in a web browser.dependencies-updates
now correctly defaults to "Yes" if no answer provided.This version renames several commands and command groups to be more consistent and predictable. The intention is to name commands using the same name as the underlying tool. Several commands were also turned into command groups of individual commands, to allow more flexibility in configuration.
Old name | New name |
---|---|
lint-pylint |
pylint |
lint-pydocstyle |
pydocstyle |
lint-pycodestyle |
pycodestyle |
typecheck |
mypy |
test |
pytest |
test-unit |
pytest-unit |
test-integration |
pytest-integration |
verify-all
command group is now called verify
, to match the existing format
and lint
command groups. However, the configration option to override the verify
command group is still tool.delfino.plugins.delfino-core.verify_commands
as it already matched the new name.Affects optional dependencies installed with delfino-core
. Update your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all |
verify |
Affects list of commands visible in given command groups. Update tool.delfino.plugins.delfino-core.<COMMAND_GROUP_NAME>_commans
in your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all_commands |
verify_commands |
This is an implementation detail that should not be relied on, but it's listed here for completeness. Command and command group names were changed to match a pattern run_<COMMAND_NAME>
and run_group_<COMMAND_GROUP_NAME>
. This is to prevent clashes with the names of the underlying tools and easier discoverability.
Old name | New name |
---|---|
coverage_open |
run_coverage_open |
coverage_report |
run_coverage_report |
dependencies_update |
run_dependencies_update |
lint |
run_group_lint |
lint_pycodestyle |
run_pycodestyle |
lint_pydocstyle |
run_pydocstyle |
lint_pylint |
run_pylint |
pre_commit |
run_pre_commit |
run_format |
run_group_format |
switch_python_version |
run_switch_python_version |
test |
run_group_test |
test_all |
run_pytest |
test_integration |
run_pytest_integration |
test_unit |
run_pytest_unit |
typecheck |
run_mypy |
verify_all |
run_group_verify |
ensure-pre-commit
pyupgrade
isort
black
format
command has been turned into a command group of individual.
ensure-pre-commit
, pyupgrade
, isort
and black
.tool.delfino.plugins.delfino-core.format_commands
option in the pyproject.toml
file.test
has been formally changed to a command group (functionally, it was already a group).
pytest
and coverage-report
.tool.delfino.plugins.delfino-core.test_commands
option in the pyproject.toml
file.pre-commit
command to run all stages of pre-commit or a single hook with the correct stage.delfino
version 3.x
, which requires pydantic>=2.0
.pyupgrade
incorrectly handling minor version number in tool.poetry.dependencies.python
of pyproject.toml
file.git push
if nothing was committed during dependencies-update
.--stash
(default) / --no-stash
option to dependencies-update
command to control whether to stash changes before updating dependencies.local_commands_directory
from delfino
.pyupgrade
into the format
commandtwine
and packaging
.upload-to-pypi
command. No longer needed with Poetry and Packagecloud uses a different upload mechanism.build-docker
command into a new plugin delfino-docker
as docker-build
.Have a look in the pyproject.toml
file. If upload-to-pypi
or build-docker
are listed under tool.delfino.plugins.delfino-core.disable_plugins
, remove them. You don't need to do anything else.
If tool.delfino.plugins.delfino-core.dockerhub
exists in the pyproject.toml
:
delfino-docker
.pyproject.toml
, create a key tool.delfino.plugins.delfino-docker.docker_build
.tool.delfino.plugins.delfino-core.dockerhub
under this new key.username
to dockerhub_username
.upload_to_pypi
and build_docker
extra dependency groups. Missing groups will be simply ignored during installation, so this is not a breaking change.twine
and packaging
in the all
group.dependencies-update
command:
dependencies-update
no longer prints out executed commands since delfino>=0.29.0
logs all executed commands in debug level. Use --log-level debug
to see them.format
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.git-python
is installed after it's use is attempted.poetry
in the dependencies-update
command.dependencies-update
for pipenv
.utils.execute_commands_group
will receive passed arguments as passed_args
from config, if they use the delfino.decorators.pass_args
decorator. Example:
[tool.delfino.plugins.delfino-core.lint-pylint]
pass_args = "--fail-under 0.9"
will pass --fail-under 0.9
to pylint
executed by lint-pylint
, which is in lint
group, which itself is in verify-all
group.utils.execute_commands_group
logs a debug message when a command is not executed because it is disabled.pytest
with extra modules via the tool.delfino.plugins.delfino-core.pytest_modules
config.pytest
with extra modules via tool.delfino.plugins.delfino-core.pytest_modules
config. Each value in this list will prepend pytest
with -m <MODULE NAME>
.lint
command group can be overriden with tool.delfino.plugins.delfino-core.lint_commands
option in the pyproject.toml
file.PYTHONPATH
environment variable in tests.test
, which is the same as test-all
but without coverage.typecheck
will print additional headings if any folders are in a strict mode.test-unit
and test-integration
no longer support the --maxfail
and --debug
flags. Use the passthrough option (any argument after --
) to pass these flags to pytest directly with --maxfail
and -s
respectively.test-all
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.passed_args
.lint
, lint-pylint
, lint-pydocstyle
and lint-pycodestyle
commands takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.--
, which are then passed to the underlying tool:
lint-pycodestyle
lint-pydocstyle
lint-pylint
test-integration
test-unit
typecheck
dependencies-update
and optional dependency group dependencies_update
.build-docker
of cargo
on ARMv7 in emulator.typecheck
no longer accepts an arbitrary list of arguments interpreted as list of files to use. Use -f
/--file
/--folder
instead. This option must be repeated for multiple files/folders.delfino
to allow faster initial development.delfino
.delfino
.All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog
and this project adheres to Semantic Versioning.
Types of changes are:
glab
that wraps the glab
CLI tool. Similar to the existing gh
command, it has the following subcommands:
glab mr create
glab mr start
glab mr view
vcs
that auto-selects the correct VCS CLI tool in the current directory based on git remote. Currently, gh
and glab
are supported. It has the following subcommands:
vcs pr/mr create
vcs pr/mr start
vcs pr/mr view
PyYAML
when the pre-commit
command is not used.ruff
as an optional dependency in the verify
group.dependencies-update
introduced by update of delfino
.dependencies-update
strips final underscore from the branch name.verify
and dependencies-update
commands with spinners.ruff
. It has been also added to the lint
command group.gh
with additional functionality on top of the gh
CLI tool:
gh pr create
adds sensible defaults for a single developer per branch to ask for almost no input. It also accepts a title of the PR as free text after the commands, as long as it doesn't start with a -
.gh pr start
is a new command, which is like gh pr create
, but also creates a new branch with a name matching the PR title, prefixed with current user's username. This branch is based off latest main and pushed to remote with an empty commit.gh pr view
default to opening the PR in a web browser.dependencies-updates
now correctly defaults to "Yes" if no answer provided.This version renames several commands and command groups to be more consistent and predictable. The intention is to name commands using the same name as the underlying tool. Several commands were also turned into command groups of individual commands, to allow more flexibility in configuration.
Old name | New name |
---|---|
lint-pylint |
pylint |
lint-pydocstyle |
pydocstyle |
lint-pycodestyle |
pycodestyle |
typecheck |
mypy |
test |
pytest |
test-unit |
pytest-unit |
test-integration |
pytest-integration |
verify-all
command group is now called verify
, to match the existing format
and lint
command groups. However, the configration option to override the verify
command group is still tool.delfino.plugins.delfino-core.verify_commands
as it already matched the new name.Affects optional dependencies installed with delfino-core
. Update your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all |
verify |
Affects list of commands visible in given command groups. Update tool.delfino.plugins.delfino-core.<COMMAND_GROUP_NAME>_commans
in your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all_commands |
verify_commands |
This is an implementation detail that should not be relied on, but it's listed here for completeness. Command and command group names were changed to match a pattern run_<COMMAND_NAME>
and run_group_<COMMAND_GROUP_NAME>
. This is to prevent clashes with the names of the underlying tools and easier discoverability.
Old name | New name |
---|---|
coverage_open |
run_coverage_open |
coverage_report |
run_coverage_report |
dependencies_update |
run_dependencies_update |
lint |
run_group_lint |
lint_pycodestyle |
run_pycodestyle |
lint_pydocstyle |
run_pydocstyle |
lint_pylint |
run_pylint |
pre_commit |
run_pre_commit |
run_format |
run_group_format |
switch_python_version |
run_switch_python_version |
test |
run_group_test |
test_all |
run_pytest |
test_integration |
run_pytest_integration |
test_unit |
run_pytest_unit |
typecheck |
run_mypy |
verify_all |
run_group_verify |
ensure-pre-commit
pyupgrade
isort
black
format
command has been turned into a command group of individual.
ensure-pre-commit
, pyupgrade
, isort
and black
.tool.delfino.plugins.delfino-core.format_commands
option in the pyproject.toml
file.test
has been formally changed to a command group (functionally, it was already a group).
pytest
and coverage-report
.tool.delfino.plugins.delfino-core.test_commands
option in the pyproject.toml
file.pre-commit
command to run all stages of pre-commit or a single hook with the correct stage.delfino
version 3.x
, which requires pydantic>=2.0
.pyupgrade
incorrectly handling minor version number in tool.poetry.dependencies.python
of pyproject.toml
file.git push
if nothing was committed during dependencies-update
.--stash
(default) / --no-stash
option to dependencies-update
command to control whether to stash changes before updating dependencies.local_commands_directory
from delfino
.pyupgrade
into the format
commandtwine
and packaging
.upload-to-pypi
command. No longer needed with Poetry and Packagecloud uses a different upload mechanism.build-docker
command into a new plugin delfino-docker
as docker-build
.Have a look in the pyproject.toml
file. If upload-to-pypi
or build-docker
are listed under tool.delfino.plugins.delfino-core.disable_plugins
, remove them. You don't need to do anything else.
If tool.delfino.plugins.delfino-core.dockerhub
exists in the pyproject.toml
:
delfino-docker
.pyproject.toml
, create a key tool.delfino.plugins.delfino-docker.docker_build
.tool.delfino.plugins.delfino-core.dockerhub
under this new key.username
to dockerhub_username
.upload_to_pypi
and build_docker
extra dependency groups. Missing groups will be simply ignored during installation, so this is not a breaking change.twine
and packaging
in the all
group.dependencies-update
command:
dependencies-update
no longer prints out executed commands since delfino>=0.29.0
logs all executed commands in debug level. Use --log-level debug
to see them.format
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.git-python
is installed after it's use is attempted.poetry
in the dependencies-update
command.dependencies-update
for pipenv
.utils.execute_commands_group
will receive passed arguments as passed_args
from config, if they use the delfino.decorators.pass_args
decorator. Example:
[tool.delfino.plugins.delfino-core.lint-pylint]
pass_args = "--fail-under 0.9"
will pass --fail-under 0.9
to pylint
executed by lint-pylint
, which is in lint
group, which itself is in verify-all
group.utils.execute_commands_group
logs a debug message when a command is not executed because it is disabled.pytest
with extra modules via the tool.delfino.plugins.delfino-core.pytest_modules
config.pytest
with extra modules via tool.delfino.plugins.delfino-core.pytest_modules
config. Each value in this list will prepend pytest
with -m <MODULE NAME>
.lint
command group can be overriden with tool.delfino.plugins.delfino-core.lint_commands
option in the pyproject.toml
file.PYTHONPATH
environment variable in tests.test
, which is the same as test-all
but without coverage.typecheck
will print additional headings if any folders are in a strict mode.test-unit
and test-integration
no longer support the --maxfail
and --debug
flags. Use the passthrough option (any argument after --
) to pass these flags to pytest directly with --maxfail
and -s
respectively.test-all
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.passed_args
.lint
, lint-pylint
, lint-pydocstyle
and lint-pycodestyle
commands takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.--
, which are then passed to the underlying tool:
lint-pycodestyle
lint-pydocstyle
lint-pylint
test-integration
test-unit
typecheck
dependencies-update
and optional dependency group dependencies_update
.build-docker
of cargo
on ARMv7 in emulator.typecheck
no longer accepts an arbitrary list of arguments interpreted as list of files to use. Use -f
/--file
/--folder
instead. This option must be repeated for multiple files/folders.delfino
to allow faster initial development.delfino
.delfino
.All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog
and this project adheres to Semantic Versioning.
Types of changes are:
PyYAML
when the pre-commit
command is not used.ruff
as an optional dependency in the verify
group.dependencies-update
introduced by update of delfino
.dependencies-update
strips final underscore from the branch name.verify
and dependencies-update
commands with spinners.ruff
. It has been also added to the lint
command group.gh
with additional functionality on top of the gh
CLI tool:
gh pr create
adds sensible defaults for a single developer per branch to ask for almost no input. It also accepts a title of the PR as free text after the commands, as long as it doesn't start with a -
.gh pr start
is a new command, which is like gh pr create
, but also creates a new branch with a name matching the PR title, prefixed with current user's username. This branch is based off latest main and pushed to remote with an empty commit.gh pr view
default to opening the PR in a web browser.dependencies-updates
now correctly defaults to "Yes" if no answer provided.This version renames several commands and command groups to be more consistent and predictable. The intention is to name commands using the same name as the underlying tool. Several commands were also turned into command groups of individual commands, to allow more flexibility in configuration.
Old name | New name |
---|---|
lint-pylint |
pylint |
lint-pydocstyle |
pydocstyle |
lint-pycodestyle |
pycodestyle |
typecheck |
mypy |
test |
pytest |
test-unit |
pytest-unit |
test-integration |
pytest-integration |
verify-all
command group is now called verify
, to match the existing format
and lint
command groups. However, the configration option to override the verify
command group is still tool.delfino.plugins.delfino-core.verify_commands
as it already matched the new name.Affects optional dependencies installed with delfino-core
. Update your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all |
verify |
Affects list of commands visible in given command groups. Update tool.delfino.plugins.delfino-core.<COMMAND_GROUP_NAME>_commans
in your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all_commands |
verify_commands |
This is an implementation detail that should not be relied on, but it's listed here for completeness. Command and command group names were changed to match a pattern run_<COMMAND_NAME>
and run_group_<COMMAND_GROUP_NAME>
. This is to prevent clashes with the names of the underlying tools and easier discoverability.
Old name | New name |
---|---|
coverage_open |
run_coverage_open |
coverage_report |
run_coverage_report |
dependencies_update |
run_dependencies_update |
lint |
run_group_lint |
lint_pycodestyle |
run_pycodestyle |
lint_pydocstyle |
run_pydocstyle |
lint_pylint |
run_pylint |
pre_commit |
run_pre_commit |
run_format |
run_group_format |
switch_python_version |
run_switch_python_version |
test |
run_group_test |
test_all |
run_pytest |
test_integration |
run_pytest_integration |
test_unit |
run_pytest_unit |
typecheck |
run_mypy |
verify_all |
run_group_verify |
ensure-pre-commit
pyupgrade
isort
black
format
command has been turned into a command group of individual.
ensure-pre-commit
, pyupgrade
, isort
and black
.tool.delfino.plugins.delfino-core.format_commands
option in the pyproject.toml
file.test
has been formally changed to a command group (functionally, it was already a group).
pytest
and coverage-report
.tool.delfino.plugins.delfino-core.test_commands
option in the pyproject.toml
file.pre-commit
command to run all stages of pre-commit or a single hook with the correct stage.delfino
version 3.x
, which requires pydantic>=2.0
.pyupgrade
incorrectly handling minor version number in tool.poetry.dependencies.python
of pyproject.toml
file.git push
if nothing was committed during dependencies-update
.--stash
(default) / --no-stash
option to dependencies-update
command to control whether to stash changes before updating dependencies.local_commands_directory
from delfino
.pyupgrade
into the format
commandtwine
and packaging
.upload-to-pypi
command. No longer needed with Poetry and Packagecloud uses a different upload mechanism.build-docker
command into a new plugin delfino-docker
as docker-build
.Have a look in the pyproject.toml
file. If upload-to-pypi
or build-docker
are listed under tool.delfino.plugins.delfino-core.disable_plugins
, remove them. You don't need to do anything else.
If tool.delfino.plugins.delfino-core.dockerhub
exists in the pyproject.toml
:
delfino-docker
.pyproject.toml
, create a key tool.delfino.plugins.delfino-docker.docker_build
.tool.delfino.plugins.delfino-core.dockerhub
under this new key.username
to dockerhub_username
.upload_to_pypi
and build_docker
extra dependency groups. Missing groups will be simply ignored during installation, so this is not a breaking change.twine
and packaging
in the all
group.dependencies-update
command:
dependencies-update
no longer prints out executed commands since delfino>=0.29.0
logs all executed commands in debug level. Use --log-level debug
to see them.format
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.git-python
is installed after it's use is attempted.poetry
in the dependencies-update
command.dependencies-update
for pipenv
.utils.execute_commands_group
will receive passed arguments as passed_args
from config, if they use the delfino.decorators.pass_args
decorator. Example:
[tool.delfino.plugins.delfino-core.lint-pylint]
pass_args = "--fail-under 0.9"
will pass --fail-under 0.9
to pylint
executed by lint-pylint
, which is in lint
group, which itself is in verify-all
group.utils.execute_commands_group
logs a debug message when a command is not executed because it is disabled.pytest
with extra modules via the tool.delfino.plugins.delfino-core.pytest_modules
config.pytest
with extra modules via tool.delfino.plugins.delfino-core.pytest_modules
config. Each value in this list will prepend pytest
with -m <MODULE NAME>
.lint
command group can be overriden with tool.delfino.plugins.delfino-core.lint_commands
option in the pyproject.toml
file.PYTHONPATH
environment variable in tests.test
, which is the same as test-all
but without coverage.typecheck
will print additional headings if any folders are in a strict mode.test-unit
and test-integration
no longer support the --maxfail
and --debug
flags. Use the passthrough option (any argument after --
) to pass these flags to pytest directly with --maxfail
and -s
respectively.test-all
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.passed_args
.lint
, lint-pylint
, lint-pydocstyle
and lint-pycodestyle
commands takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.--
, which are then passed to the underlying tool:
lint-pycodestyle
lint-pydocstyle
lint-pylint
test-integration
test-unit
typecheck
dependencies-update
and optional dependency group dependencies_update
.build-docker
of cargo
on ARMv7 in emulator.typecheck
no longer accepts an arbitrary list of arguments interpreted as list of files to use. Use -f
/--file
/--folder
instead. This option must be repeated for multiple files/folders.delfino
to allow faster initial development.delfino
.delfino
.All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog
and this project adheres to Semantic Versioning.
Types of changes are:
ruff
as an optional dependency in the verify
group.dependencies-update
introduced by update of delfino
.dependencies-update
strips final underscore from the branch name.verify
and dependencies-update
commands with spinners.ruff
. It has been also added to the lint
command group.gh
with additional functionality on top of the gh
CLI tool:
gh pr create
adds sensible defaults for a single developer per branch to ask for almost no input. It also accepts a title of the PR as free text after the commands, as long as it doesn't start with a -
.gh pr start
is a new command, which is like gh pr create
, but also creates a new branch with a name matching the PR title, prefixed with current user's username. This branch is based off latest main and pushed to remote with an empty commit.gh pr view
default to opening the PR in a web browser.dependencies-updates
now correctly defaults to "Yes" if no answer provided.This version renames several commands and command groups to be more consistent and predictable. The intention is to name commands using the same name as the underlying tool. Several commands were also turned into command groups of individual commands, to allow more flexibility in configuration.
Old name | New name |
---|---|
lint-pylint |
pylint |
lint-pydocstyle |
pydocstyle |
lint-pycodestyle |
pycodestyle |
typecheck |
mypy |
test |
pytest |
test-unit |
pytest-unit |
test-integration |
pytest-integration |
verify-all
command group is now called verify
, to match the existing format
and lint
command groups. However, the configration option to override the verify
command group is still tool.delfino.plugins.delfino-core.verify_commands
as it already matched the new name.Affects optional dependencies installed with delfino-core
. Update your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all |
verify |
Affects list of commands visible in given command groups. Update tool.delfino.plugins.delfino-core.<COMMAND_GROUP_NAME>_commans
in your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all_commands |
verify_commands |
This is an implementation detail that should not be relied on, but it's listed here for completeness. Command and command group names were changed to match a pattern run_<COMMAND_NAME>
and run_group_<COMMAND_GROUP_NAME>
. This is to prevent clashes with the names of the underlying tools and easier discoverability.
Old name | New name |
---|---|
coverage_open |
run_coverage_open |
coverage_report |
run_coverage_report |
dependencies_update |
run_dependencies_update |
lint |
run_group_lint |
lint_pycodestyle |
run_pycodestyle |
lint_pydocstyle |
run_pydocstyle |
lint_pylint |
run_pylint |
pre_commit |
run_pre_commit |
run_format |
run_group_format |
switch_python_version |
run_switch_python_version |
test |
run_group_test |
test_all |
run_pytest |
test_integration |
run_pytest_integration |
test_unit |
run_pytest_unit |
typecheck |
run_mypy |
verify_all |
run_group_verify |
ensure-pre-commit
pyupgrade
isort
black
format
command has been turned into a command group of individual.
ensure-pre-commit
, pyupgrade
, isort
and black
.tool.delfino.plugins.delfino-core.format_commands
option in the pyproject.toml
file.test
has been formally changed to a command group (functionally, it was already a group).
pytest
and coverage-report
.tool.delfino.plugins.delfino-core.test_commands
option in the pyproject.toml
file.pre-commit
command to run all stages of pre-commit or a single hook with the correct stage.delfino
version 3.x
, which requires pydantic>=2.0
.pyupgrade
incorrectly handling minor version number in tool.poetry.dependencies.python
of pyproject.toml
file.git push
if nothing was committed during dependencies-update
.--stash
(default) / --no-stash
option to dependencies-update
command to control whether to stash changes before updating dependencies.local_commands_directory
from delfino
.pyupgrade
into the format
commandtwine
and packaging
.upload-to-pypi
command. No longer needed with Poetry and Packagecloud uses a different upload mechanism.build-docker
command into a new plugin delfino-docker
as docker-build
.Have a look in the pyproject.toml
file. If upload-to-pypi
or build-docker
are listed under tool.delfino.plugins.delfino-core.disable_plugins
, remove them. You don't need to do anything else.
If tool.delfino.plugins.delfino-core.dockerhub
exists in the pyproject.toml
:
delfino-docker
.pyproject.toml
, create a key tool.delfino.plugins.delfino-docker.docker_build
.tool.delfino.plugins.delfino-core.dockerhub
under this new key.username
to dockerhub_username
.upload_to_pypi
and build_docker
extra dependency groups. Missing groups will be simply ignored during installation, so this is not a breaking change.twine
and packaging
in the all
group.dependencies-update
command:
dependencies-update
no longer prints out executed commands since delfino>=0.29.0
logs all executed commands in debug level. Use --log-level debug
to see them.format
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.git-python
is installed after it's use is attempted.poetry
in the dependencies-update
command.dependencies-update
for pipenv
.utils.execute_commands_group
will receive passed arguments as passed_args
from config, if they use the delfino.decorators.pass_args
decorator. Example:
[tool.delfino.plugins.delfino-core.lint-pylint]
pass_args = "--fail-under 0.9"
will pass --fail-under 0.9
to pylint
executed by lint-pylint
, which is in lint
group, which itself is in verify-all
group.utils.execute_commands_group
logs a debug message when a command is not executed because it is disabled.pytest
with extra modules via the tool.delfino.plugins.delfino-core.pytest_modules
config.pytest
with extra modules via tool.delfino.plugins.delfino-core.pytest_modules
config. Each value in this list will prepend pytest
with -m <MODULE NAME>
.lint
command group can be overriden with tool.delfino.plugins.delfino-core.lint_commands
option in the pyproject.toml
file.PYTHONPATH
environment variable in tests.test
, which is the same as test-all
but without coverage.typecheck
will print additional headings if any folders are in a strict mode.test-unit
and test-integration
no longer support the --maxfail
and --debug
flags. Use the passthrough option (any argument after --
) to pass these flags to pytest directly with --maxfail
and -s
respectively.test-all
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.passed_args
.lint
, lint-pylint
, lint-pydocstyle
and lint-pycodestyle
commands takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.--
, which are then passed to the underlying tool:
lint-pycodestyle
lint-pydocstyle
lint-pylint
test-integration
test-unit
typecheck
dependencies-update
and optional dependency group dependencies_update
.build-docker
of cargo
on ARMv7 in emulator.typecheck
no longer accepts an arbitrary list of arguments interpreted as list of files to use. Use -f
/--file
/--folder
instead. This option must be repeated for multiple files/folders.delfino
to allow faster initial development.delfino
.delfino
.All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog
and this project adheres to Semantic Versioning.
Types of changes are:
dependencies-update
introduced by update of delfino
.dependencies-update
strips final underscore from the branch name.verify
and dependencies-update
commands with spinners.ruff
. It has been also added to the lint
command group.gh
with additional functionality on top of the gh
CLI tool:
gh pr create
adds sensible defaults for a single developer per branch to ask for almost no input. It also accepts a title of the PR as free text after the commands, as long as it doesn't start with a -
.gh pr start
is a new command, which is like gh pr create
, but also creates a new branch with a name matching the PR title, prefixed with current user's username. This branch is based off latest main and pushed to remote with an empty commit.gh pr view
default to opening the PR in a web browser.dependencies-updates
now correctly defaults to "Yes" if no answer provided.This version renames several commands and command groups to be more consistent and predictable. The intention is to name commands using the same name as the underlying tool. Several commands were also turned into command groups of individual commands, to allow more flexibility in configuration.
Old name | New name |
---|---|
lint-pylint |
pylint |
lint-pydocstyle |
pydocstyle |
lint-pycodestyle |
pycodestyle |
typecheck |
mypy |
test |
pytest |
test-unit |
pytest-unit |
test-integration |
pytest-integration |
verify-all
command group is now called verify
, to match the existing format
and lint
command groups. However, the configration option to override the verify
command group is still tool.delfino.plugins.delfino-core.verify_commands
as it already matched the new name.Affects optional dependencies installed with delfino-core
. Update your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all |
verify |
Affects list of commands visible in given command groups. Update tool.delfino.plugins.delfino-core.<COMMAND_GROUP_NAME>_commans
in your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all_commands |
verify_commands |
This is an implementation detail that should not be relied on, but it's listed here for completeness. Command and command group names were changed to match a pattern run_<COMMAND_NAME>
and run_group_<COMMAND_GROUP_NAME>
. This is to prevent clashes with the names of the underlying tools and easier discoverability.
Old name | New name |
---|---|
coverage_open |
run_coverage_open |
coverage_report |
run_coverage_report |
dependencies_update |
run_dependencies_update |
lint |
run_group_lint |
lint_pycodestyle |
run_pycodestyle |
lint_pydocstyle |
run_pydocstyle |
lint_pylint |
run_pylint |
pre_commit |
run_pre_commit |
run_format |
run_group_format |
switch_python_version |
run_switch_python_version |
test |
run_group_test |
test_all |
run_pytest |
test_integration |
run_pytest_integration |
test_unit |
run_pytest_unit |
typecheck |
run_mypy |
verify_all |
run_group_verify |
ensure-pre-commit
pyupgrade
isort
black
format
command has been turned into a command group of individual.
ensure-pre-commit
, pyupgrade
, isort
and black
.tool.delfino.plugins.delfino-core.format_commands
option in the pyproject.toml
file.test
has been formally changed to a command group (functionally, it was already a group).
pytest
and coverage-report
.tool.delfino.plugins.delfino-core.test_commands
option in the pyproject.toml
file.pre-commit
command to run all stages of pre-commit or a single hook with the correct stage.delfino
version 3.x
, which requires pydantic>=2.0
.pyupgrade
incorrectly handling minor version number in tool.poetry.dependencies.python
of pyproject.toml
file.git push
if nothing was committed during dependencies-update
.--stash
(default) / --no-stash
option to dependencies-update
command to control whether to stash changes before updating dependencies.local_commands_directory
from delfino
.pyupgrade
into the format
commandtwine
and packaging
.upload-to-pypi
command. No longer needed with Poetry and Packagecloud uses a different upload mechanism.build-docker
command into a new plugin delfino-docker
as docker-build
.Have a look in the pyproject.toml
file. If upload-to-pypi
or build-docker
are listed under tool.delfino.plugins.delfino-core.disable_plugins
, remove them. You don't need to do anything else.
If tool.delfino.plugins.delfino-core.dockerhub
exists in the pyproject.toml
:
delfino-docker
.pyproject.toml
, create a key tool.delfino.plugins.delfino-docker.docker_build
.tool.delfino.plugins.delfino-core.dockerhub
under this new key.username
to dockerhub_username
.upload_to_pypi
and build_docker
extra dependency groups. Missing groups will be simply ignored during installation, so this is not a breaking change.twine
and packaging
in the all
group.dependencies-update
command:
dependencies-update
no longer prints out executed commands since delfino>=0.29.0
logs all executed commands in debug level. Use --log-level debug
to see them.format
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.git-python
is installed after it's use is attempted.poetry
in the dependencies-update
command.dependencies-update
for pipenv
.utils.execute_commands_group
will receive passed arguments as passed_args
from config, if they use the delfino.decorators.pass_args
decorator. Example:
[tool.delfino.plugins.delfino-core.lint-pylint]
pass_args = "--fail-under 0.9"
will pass --fail-under 0.9
to pylint
executed by lint-pylint
, which is in lint
group, which itself is in verify-all
group.utils.execute_commands_group
logs a debug message when a command is not executed because it is disabled.pytest
with extra modules via the tool.delfino.plugins.delfino-core.pytest_modules
config.pytest
with extra modules via tool.delfino.plugins.delfino-core.pytest_modules
config. Each value in this list will prepend pytest
with -m <MODULE NAME>
.lint
command group can be overriden with tool.delfino.plugins.delfino-core.lint_commands
option in the pyproject.toml
file.PYTHONPATH
environment variable in tests.test
, which is the same as test-all
but without coverage.typecheck
will print additional headings if any folders are in a strict mode.test-unit
and test-integration
no longer support the --maxfail
and --debug
flags. Use the passthrough option (any argument after --
) to pass these flags to pytest directly with --maxfail
and -s
respectively.test-all
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.passed_args
.lint
, lint-pylint
, lint-pydocstyle
and lint-pycodestyle
commands takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.--
, which are then passed to the underlying tool:
lint-pycodestyle
lint-pydocstyle
lint-pylint
test-integration
test-unit
typecheck
dependencies-update
and optional dependency group dependencies_update
.build-docker
of cargo
on ARMv7 in emulator.typecheck
no longer accepts an arbitrary list of arguments interpreted as list of files to use. Use -f
/--file
/--folder
instead. This option must be repeated for multiple files/folders.delfino
to allow faster initial development.delfino
.delfino
.All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog
and this project adheres to Semantic Versioning.
Types of changes are:
dependencies-update
:
delfino
.verify
and dependencies-update
commands with spinners.ruff
. It has been also added to the lint
command group.gh
with additional functionality on top of the gh
CLI tool:
gh pr create
adds sensible defaults for a single developer per branch to ask for almost no input. It also accepts a title of the PR as free text after the commands, as long as it doesn't start with a -
.gh pr start
is a new command, which is like gh pr create
, but also creates a new branch with a name matching the PR title, prefixed with current user's username. This branch is based off latest main and pushed to remote with an empty commit.gh pr view
default to opening the PR in a web browser.dependencies-updates
now correctly defaults to "Yes" if no answer provided.This version renames several commands and command groups to be more consistent and predictable. The intention is to name commands using the same name as the underlying tool. Several commands were also turned into command groups of individual commands, to allow more flexibility in configuration.
Old name | New name |
---|---|
lint-pylint |
pylint |
lint-pydocstyle |
pydocstyle |
lint-pycodestyle |
pycodestyle |
typecheck |
mypy |
test |
pytest |
test-unit |
pytest-unit |
test-integration |
pytest-integration |
verify-all
command group is now called verify
, to match the existing format
and lint
command groups. However, the configration option to override the verify
command group is still tool.delfino.plugins.delfino-core.verify_commands
as it already matched the new name.Affects optional dependencies installed with delfino-core
. Update your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all |
verify |
Affects list of commands visible in given command groups. Update tool.delfino.plugins.delfino-core.<COMMAND_GROUP_NAME>_commans
in your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all_commands |
verify_commands |
This is an implementation detail that should not be relied on, but it's listed here for completeness. Command and command group names were changed to match a pattern run_<COMMAND_NAME>
and run_group_<COMMAND_GROUP_NAME>
. This is to prevent clashes with the names of the underlying tools and easier discoverability.
Old name | New name |
---|---|
coverage_open |
run_coverage_open |
coverage_report |
run_coverage_report |
dependencies_update |
run_dependencies_update |
lint |
run_group_lint |
lint_pycodestyle |
run_pycodestyle |
lint_pydocstyle |
run_pydocstyle |
lint_pylint |
run_pylint |
pre_commit |
run_pre_commit |
run_format |
run_group_format |
switch_python_version |
run_switch_python_version |
test |
run_group_test |
test_all |
run_pytest |
test_integration |
run_pytest_integration |
test_unit |
run_pytest_unit |
typecheck |
run_mypy |
verify_all |
run_group_verify |
ensure-pre-commit
pyupgrade
isort
black
format
command has been turned into a command group of individual.
ensure-pre-commit
, pyupgrade
, isort
and black
.tool.delfino.plugins.delfino-core.format_commands
option in the pyproject.toml
file.test
has been formally changed to a command group (functionally, it was already a group).
pytest
and coverage-report
.tool.delfino.plugins.delfino-core.test_commands
option in the pyproject.toml
file.pre-commit
command to run all stages of pre-commit or a single hook with the correct stage.delfino
version 3.x
, which requires pydantic>=2.0
.pyupgrade
incorrectly handling minor version number in tool.poetry.dependencies.python
of pyproject.toml
file.git push
if nothing was committed during dependencies-update
.--stash
(default) / --no-stash
option to dependencies-update
command to control whether to stash changes before updating dependencies.local_commands_directory
from delfino
.pyupgrade
into the format
commandtwine
and packaging
.upload-to-pypi
command. No longer needed with Poetry and Packagecloud uses a different upload mechanism.build-docker
command into a new plugin delfino-docker
as docker-build
.Have a look in the pyproject.toml
file. If upload-to-pypi
or build-docker
are listed under tool.delfino.plugins.delfino-core.disable_plugins
, remove them. You don't need to do anything else.
If tool.delfino.plugins.delfino-core.dockerhub
exists in the pyproject.toml
:
delfino-docker
.pyproject.toml
, create a key tool.delfino.plugins.delfino-docker.docker_build
.tool.delfino.plugins.delfino-core.dockerhub
under this new key.username
to dockerhub_username
.upload_to_pypi
and build_docker
extra dependency groups. Missing groups will be simply ignored during installation, so this is not a breaking change.twine
and packaging
in the all
group.dependencies-update
command:
dependencies-update
no longer prints out executed commands since delfino>=0.29.0
logs all executed commands in debug level. Use --log-level debug
to see them.format
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.git-python
is installed after it's use is attempted.poetry
in the dependencies-update
command.dependencies-update
for pipenv
.utils.execute_commands_group
will receive passed arguments as passed_args
from config, if they use the delfino.decorators.pass_args
decorator. Example:
[tool.delfino.plugins.delfino-core.lint-pylint]
pass_args = "--fail-under 0.9"
will pass --fail-under 0.9
to pylint
executed by lint-pylint
, which is in lint
group, which itself is in verify-all
group.utils.execute_commands_group
logs a debug message when a command is not executed because it is disabled.pytest
with extra modules via the tool.delfino.plugins.delfino-core.pytest_modules
config.pytest
with extra modules via tool.delfino.plugins.delfino-core.pytest_modules
config. Each value in this list will prepend pytest
with -m <MODULE NAME>
.lint
command group can be overriden with tool.delfino.plugins.delfino-core.lint_commands
option in the pyproject.toml
file.PYTHONPATH
environment variable in tests.test
, which is the same as test-all
but without coverage.typecheck
will print additional headings if any folders are in a strict mode.test-unit
and test-integration
no longer support the --maxfail
and --debug
flags. Use the passthrough option (any argument after --
) to pass these flags to pytest directly with --maxfail
and -s
respectively.test-all
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.passed_args
.lint
, lint-pylint
, lint-pydocstyle
and lint-pycodestyle
commands takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.--
, which are then passed to the underlying tool:
lint-pycodestyle
lint-pydocstyle
lint-pylint
test-integration
test-unit
typecheck
dependencies-update
and optional dependency group dependencies_update
.build-docker
of cargo
on ARMv7 in emulator.typecheck
no longer accepts an arbitrary list of arguments interpreted as list of files to use. Use -f
/--file
/--folder
instead. This option must be repeated for multiple files/folders.delfino
to allow faster initial development.delfino
.delfino
.All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog
and this project adheres to Semantic Versioning.
Types of changes are:
verify
and dependencies-update
commands with spinners.ruff
. It has been also added to the lint
command group.gh
with additional functionality on top of the gh
CLI tool:
gh pr create
adds sensible defaults for a single developer per branch to ask for almost no input. It also accepts a title of the PR as free text after the commands, as long as it doesn't start with a -
.gh pr start
is a new command, which is like gh pr create
, but also creates a new branch with a name matching the PR title, prefixed with current user's username. This branch is based off latest main and pushed to remote with an empty commit.gh pr view
default to opening the PR in a web browser.dependencies-updates
now correctly defaults to "Yes" if no answer provided.This version renames several commands and command groups to be more consistent and predictable. The intention is to name commands using the same name as the underlying tool. Several commands were also turned into command groups of individual commands, to allow more flexibility in configuration.
Old name | New name |
---|---|
lint-pylint |
pylint |
lint-pydocstyle |
pydocstyle |
lint-pycodestyle |
pycodestyle |
typecheck |
mypy |
test |
pytest |
test-unit |
pytest-unit |
test-integration |
pytest-integration |
verify-all
command group is now called verify
, to match the existing format
and lint
command groups. However, the configration option to override the verify
command group is still tool.delfino.plugins.delfino-core.verify_commands
as it already matched the new name.Affects optional dependencies installed with delfino-core
. Update your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all |
verify |
Affects list of commands visible in given command groups. Update tool.delfino.plugins.delfino-core.<COMMAND_GROUP_NAME>_commans
in your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all_commands |
verify_commands |
This is an implementation detail that should not be relied on, but it's listed here for completeness. Command and command group names were changed to match a pattern run_<COMMAND_NAME>
and run_group_<COMMAND_GROUP_NAME>
. This is to prevent clashes with the names of the underlying tools and easier discoverability.
Old name | New name |
---|---|
coverage_open |
run_coverage_open |
coverage_report |
run_coverage_report |
dependencies_update |
run_dependencies_update |
lint |
run_group_lint |
lint_pycodestyle |
run_pycodestyle |
lint_pydocstyle |
run_pydocstyle |
lint_pylint |
run_pylint |
pre_commit |
run_pre_commit |
run_format |
run_group_format |
switch_python_version |
run_switch_python_version |
test |
run_group_test |
test_all |
run_pytest |
test_integration |
run_pytest_integration |
test_unit |
run_pytest_unit |
typecheck |
run_mypy |
verify_all |
run_group_verify |
ensure-pre-commit
pyupgrade
isort
black
format
command has been turned into a command group of individual.
ensure-pre-commit
, pyupgrade
, isort
and black
.tool.delfino.plugins.delfino-core.format_commands
option in the pyproject.toml
file.test
has been formally changed to a command group (functionally, it was already a group).
pytest
and coverage-report
.tool.delfino.plugins.delfino-core.test_commands
option in the pyproject.toml
file.pre-commit
command to run all stages of pre-commit or a single hook with the correct stage.delfino
version 3.x
, which requires pydantic>=2.0
.pyupgrade
incorrectly handling minor version number in tool.poetry.dependencies.python
of pyproject.toml
file.git push
if nothing was committed during dependencies-update
.--stash
(default) / --no-stash
option to dependencies-update
command to control whether to stash changes before updating dependencies.local_commands_directory
from delfino
.pyupgrade
into the format
commandtwine
and packaging
.upload-to-pypi
command. No longer needed with Poetry and Packagecloud uses a different upload mechanism.build-docker
command into a new plugin delfino-docker
as docker-build
.Have a look in the pyproject.toml
file. If upload-to-pypi
or build-docker
are listed under tool.delfino.plugins.delfino-core.disable_plugins
, remove them. You don't need to do anything else.
If tool.delfino.plugins.delfino-core.dockerhub
exists in the pyproject.toml
:
delfino-docker
.pyproject.toml
, create a key tool.delfino.plugins.delfino-docker.docker_build
.tool.delfino.plugins.delfino-core.dockerhub
under this new key.username
to dockerhub_username
.upload_to_pypi
and build_docker
extra dependency groups. Missing groups will be simply ignored during installation, so this is not a breaking change.twine
and packaging
in the all
group.dependencies-update
command:
dependencies-update
no longer prints out executed commands since delfino>=0.29.0
logs all executed commands in debug level. Use --log-level debug
to see them.format
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.git-python
is installed after it's use is attempted.poetry
in the dependencies-update
command.dependencies-update
for pipenv
.utils.execute_commands_group
will receive passed arguments as passed_args
from config, if they use the delfino.decorators.pass_args
decorator. Example:
[tool.delfino.plugins.delfino-core.lint-pylint]
pass_args = "--fail-under 0.9"
will pass --fail-under 0.9
to pylint
executed by lint-pylint
, which is in lint
group, which itself is in verify-all
group.utils.execute_commands_group
logs a debug message when a command is not executed because it is disabled.pytest
with extra modules via the tool.delfino.plugins.delfino-core.pytest_modules
config.pytest
with extra modules via tool.delfino.plugins.delfino-core.pytest_modules
config. Each value in this list will prepend pytest
with -m <MODULE NAME>
.lint
command group can be overriden with tool.delfino.plugins.delfino-core.lint_commands
option in the pyproject.toml
file.PYTHONPATH
environment variable in tests.test
, which is the same as test-all
but without coverage.typecheck
will print additional headings if any folders are in a strict mode.test-unit
and test-integration
no longer support the --maxfail
and --debug
flags. Use the passthrough option (any argument after --
) to pass these flags to pytest directly with --maxfail
and -s
respectively.test-all
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.passed_args
.lint
, lint-pylint
, lint-pydocstyle
and lint-pycodestyle
commands takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.--
, which are then passed to the underlying tool:
lint-pycodestyle
lint-pydocstyle
lint-pylint
test-integration
test-unit
typecheck
dependencies-update
and optional dependency group dependencies_update
.build-docker
of cargo
on ARMv7 in emulator.typecheck
no longer accepts an arbitrary list of arguments interpreted as list of files to use. Use -f
/--file
/--folder
instead. This option must be repeated for multiple files/folders.delfino
to allow faster initial development.delfino
.delfino
.All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog
and this project adheres to Semantic Versioning.
Types of changes are:
ruff
. It has been also added to the lint
command group.gh
with additional functionality on top of the gh
CLI tool:
gh pr create
adds sensible defaults for a single developer per branch to ask for almost no input. It also accepts a title of the PR as free text after the commands, as long as it doesn't start with a -
.gh pr start
is a new command, which is like gh pr create
, but also creates a new branch with a name matching the PR title, prefixed with current user's username. This branch is based off latest main and pushed to remote with an empty commit.gh pr view
default to opening the PR in a web browser.dependencies-updates
now correctly defaults to "Yes" if no answer provided.This version renames several commands and command groups to be more consistent and predictable. The intention is to name commands using the same name as the underlying tool. Several commands were also turned into command groups of individual commands, to allow more flexibility in configuration.
Old name | New name |
---|---|
lint-pylint |
pylint |
lint-pydocstyle |
pydocstyle |
lint-pycodestyle |
pycodestyle |
typecheck |
mypy |
test |
pytest |
test-unit |
pytest-unit |
test-integration |
pytest-integration |
verify-all
command group is now called verify
, to match the existing format
and lint
command groups. However, the configration option to override the verify
command group is still tool.delfino.plugins.delfino-core.verify_commands
as it already matched the new name.Affects optional dependencies installed with delfino-core
. Update your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all |
verify |
Affects list of commands visible in given command groups. Update tool.delfino.plugins.delfino-core.<COMMAND_GROUP_NAME>_commans
in your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all_commands |
verify_commands |
This is an implementation detail that should not be relied on, but it's listed here for completeness. Command and command group names were changed to match a pattern run_<COMMAND_NAME>
and run_group_<COMMAND_GROUP_NAME>
. This is to prevent clashes with the names of the underlying tools and easier discoverability.
Old name | New name |
---|---|
coverage_open |
run_coverage_open |
coverage_report |
run_coverage_report |
dependencies_update |
run_dependencies_update |
lint |
run_group_lint |
lint_pycodestyle |
run_pycodestyle |
lint_pydocstyle |
run_pydocstyle |
lint_pylint |
run_pylint |
pre_commit |
run_pre_commit |
run_format |
run_group_format |
switch_python_version |
run_switch_python_version |
test |
run_group_test |
test_all |
run_pytest |
test_integration |
run_pytest_integration |
test_unit |
run_pytest_unit |
typecheck |
run_mypy |
verify_all |
run_group_verify |
ensure-pre-commit
pyupgrade
isort
black
format
command has been turned into a command group of individual.
ensure-pre-commit
, pyupgrade
, isort
and black
.tool.delfino.plugins.delfino-core.format_commands
option in the pyproject.toml
file.test
has been formally changed to a command group (functionally, it was already a group).
pytest
and coverage-report
.tool.delfino.plugins.delfino-core.test_commands
option in the pyproject.toml
file.pre-commit
command to run all stages of pre-commit or a single hook with the correct stage.delfino
version 3.x
, which requires pydantic>=2.0
.pyupgrade
incorrectly handling minor version number in tool.poetry.dependencies.python
of pyproject.toml
file.git push
if nothing was committed during dependencies-update
.--stash
(default) / --no-stash
option to dependencies-update
command to control whether to stash changes before updating dependencies.local_commands_directory
from delfino
.pyupgrade
into the format
commandtwine
and packaging
.upload-to-pypi
command. No longer needed with Poetry and Packagecloud uses a different upload mechanism.build-docker
command into a new plugin delfino-docker
as docker-build
.Have a look in the pyproject.toml
file. If upload-to-pypi
or build-docker
are listed under tool.delfino.plugins.delfino-core.disable_plugins
, remove them. You don't need to do anything else.
If tool.delfino.plugins.delfino-core.dockerhub
exists in the pyproject.toml
:
delfino-docker
.pyproject.toml
, create a key tool.delfino.plugins.delfino-docker.docker_build
.tool.delfino.plugins.delfino-core.dockerhub
under this new key.username
to dockerhub_username
.upload_to_pypi
and build_docker
extra dependency groups. Missing groups will be simply ignored during installation, so this is not a breaking change.twine
and packaging
in the all
group.dependencies-update
command:
dependencies-update
no longer prints out executed commands since delfino>=0.29.0
logs all executed commands in debug level. Use --log-level debug
to see them.format
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.git-python
is installed after it's use is attempted.poetry
in the dependencies-update
command.dependencies-update
for pipenv
.utils.execute_commands_group
will receive passed arguments as passed_args
from config, if they use the delfino.decorators.pass_args
decorator. Example:
[tool.delfino.plugins.delfino-core.lint-pylint]
pass_args = "--fail-under 0.9"
will pass --fail-under 0.9
to pylint
executed by lint-pylint
, which is in lint
group, which itself is in verify-all
group.utils.execute_commands_group
logs a debug message when a command is not executed because it is disabled.pytest
with extra modules via the tool.delfino.plugins.delfino-core.pytest_modules
config.pytest
with extra modules via tool.delfino.plugins.delfino-core.pytest_modules
config. Each value in this list will prepend pytest
with -m <MODULE NAME>
.lint
command group can be overriden with tool.delfino.plugins.delfino-core.lint_commands
option in the pyproject.toml
file.PYTHONPATH
environment variable in tests.test
, which is the same as test-all
but without coverage.typecheck
will print additional headings if any folders are in a strict mode.test-unit
and test-integration
no longer support the --maxfail
and --debug
flags. Use the passthrough option (any argument after --
) to pass these flags to pytest directly with --maxfail
and -s
respectively.test-all
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.passed_args
.lint
, lint-pylint
, lint-pydocstyle
and lint-pycodestyle
commands takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.--
, which are then passed to the underlying tool:
lint-pycodestyle
lint-pydocstyle
lint-pylint
test-integration
test-unit
typecheck
dependencies-update
and optional dependency group dependencies_update
.build-docker
of cargo
on ARMv7 in emulator.typecheck
no longer accepts an arbitrary list of arguments interpreted as list of files to use. Use -f
/--file
/--folder
instead. This option must be repeated for multiple files/folders.delfino
to allow faster initial development.delfino
.delfino
.All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog
and this project adheres to Semantic Versioning.
Types of changes are:
This version renames several commands and command groups to be more consistent and predictable. The intention is to name commands using the same name as the underlying tool. Several commands were also turned into command groups of individual commands, to allow more flexibility in configuration.
Old name | New name |
---|---|
lint-pylint |
pylint |
lint-pydocstyle |
pydocstyle |
lint-pycodestyle |
pycodestyle |
typecheck |
mypy |
test |
pytest |
test-unit |
pytest-unit |
test-integration |
pytest-integration |
verify-all
command group is now called verify
, to match the existing format
and lint
command groups. However, the configration option to override the verify
command group is still tool.delfino.plugins.delfino-core.verify_commands
as it already matched the new name.Affects optional dependencies installed with delfino-core
. Update your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all |
verify |
Affects list of commands visible in given command groups. Update tool.delfino.plugins.delfino-core.<COMMAND_GROUP_NAME>_commans
in your pyproject.toml
file accordingly.
Old name | New name |
---|---|
typecheck |
mypy |
verify_all_commands |
verify_commands |
This is an implementation detail that should not be relied on, but it's listed here for completeness. Command and command group names were changed to match a pattern run_<COMMAND_NAME>
and run_group_<COMMAND_GROUP_NAME>
. This is to prevent clashes with the names of the underlying tools and easier discoverability.
Old name | New name |
---|---|
coverage_open |
run_coverage_open |
coverage_report |
run_coverage_report |
dependencies_update |
run_dependencies_update |
lint |
run_group_lint |
lint_pycodestyle |
run_pycodestyle |
lint_pydocstyle |
run_pydocstyle |
lint_pylint |
run_pylint |
pre_commit |
run_pre_commit |
run_format |
run_group_format |
switch_python_version |
run_switch_python_version |
test |
run_group_test |
test_all |
run_pytest |
test_integration |
run_pytest_integration |
test_unit |
run_pytest_unit |
typecheck |
run_mypy |
verify_all |
run_group_verify |
ensure-pre-commit
pyupgrade
isort
black
format
command has been turned into a command group of individual.
ensure-pre-commit
, pyupgrade
, isort
and black
.tool.delfino.plugins.delfino-core.format_commands
option in the pyproject.toml
file.test
has been formally changed to a command group (functionally, it was already a group).
pytest
and coverage-report
.tool.delfino.plugins.delfino-core.test_commands
option in the pyproject.toml
file.pre-commit
command to run all stages of pre-commit or a single hook with the correct stage.delfino
version 3.x
, which requires pydantic>=2.0
.pyupgrade
incorrectly handling minor version number in tool.poetry.dependencies.python
of pyproject.toml
file.git push
if nothing was committed during dependencies-update
.--stash
(default) / --no-stash
option to dependencies-update
command to control whether to stash changes before updating dependencies.local_commands_directory
from delfino
.pyupgrade
into the format
commandtwine
and packaging
.upload-to-pypi
command. No longer needed with Poetry and Packagecloud uses a different upload mechanism.build-docker
command into a new plugin delfino-docker
as docker-build
.Have a look in the pyproject.toml
file. If upload-to-pypi
or build-docker
are listed under tool.delfino.plugins.delfino-core.disable_plugins
, remove them. You don't need to do anything else.
If tool.delfino.plugins.delfino-core.dockerhub
exists in the pyproject.toml
:
delfino-docker
.pyproject.toml
, create a key tool.delfino.plugins.delfino-docker.docker_build
.tool.delfino.plugins.delfino-core.dockerhub
under this new key.username
to dockerhub_username
.upload_to_pypi
and build_docker
extra dependency groups. Missing groups will be simply ignored during installation, so this is not a breaking change.twine
and packaging
in the all
group.dependencies-update
command:
dependencies-update
no longer prints out executed commands since delfino>=0.29.0
logs all executed commands in debug level. Use --log-level debug
to see them.format
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.git-python
is installed after it's use is attempted.poetry
in the dependencies-update
command.dependencies-update
for pipenv
.utils.execute_commands_group
will receive passed arguments as passed_args
from config, if they use the delfino.decorators.pass_args
decorator. Example:
[tool.delfino.plugins.delfino-core.lint-pylint]
pass_args = "--fail-under 0.9"
will pass --fail-under 0.9
to pylint
executed by lint-pylint
, which is in lint
group, which itself is in verify-all
group.utils.execute_commands_group
logs a debug message when a command is not executed because it is disabled.pytest
with extra modules via the tool.delfino.plugins.delfino-core.pytest_modules
config.pytest
with extra modules via tool.delfino.plugins.delfino-core.pytest_modules
config. Each value in this list will prepend pytest
with -m <MODULE NAME>
.lint
command group can be overriden with tool.delfino.plugins.delfino-core.lint_commands
option in the pyproject.toml
file.PYTHONPATH
environment variable in tests.test
, which is the same as test-all
but without coverage.typecheck
will print additional headings if any folders are in a strict mode.test-unit
and test-integration
no longer support the --maxfail
and --debug
flags. Use the passthrough option (any argument after --
) to pass these flags to pytest directly with --maxfail
and -s
respectively.test-all
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.passed_args
.lint
, lint-pylint
, lint-pydocstyle
and lint-pycodestyle
commands takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.--
, which are then passed to the underlying tool:
lint-pycodestyle
lint-pydocstyle
lint-pylint
test-integration
test-unit
typecheck
dependencies-update
and optional dependency group dependencies_update
.build-docker
of cargo
on ARMv7 in emulator.typecheck
no longer accepts an arbitrary list of arguments interpreted as list of files to use. Use -f
/--file
/--folder
instead. This option must be repeated for multiple files/folders.delfino
to allow faster initial development.delfino
.delfino
.All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog
and this project adheres to Semantic Versioning.
Types of changes are:
pre-commit
command to run all stages of pre-commit or a single hook with the correct stage.delfino
version 3.x
, which requires pydantic>=2.0
.pyupgrade
incorrectly handling minor version number in tool.poetry.dependencies.python
of pyproject.toml
file.git push
if nothing was committed during dependencies-update
.--stash
(default) / --no-stash
option to dependencies-update
command to control whether to stash changes before updating dependencies.local_commands_directory
from delfino
.pyupgrade
into the format
commandtwine
and packaging
.upload-to-pypi
command. No longer needed with Poetry and Packagecloud uses a different upload mechanism.build-docker
command into a new plugin delfino-docker
as docker-build
.Have a look in the pyproject.toml
file. If upload-to-pypi
or build-docker
are listed under tool.delfino.plugins.delfino-core.disable_plugins
, remove them. You don't need to do anything else.
If tool.delfino.plugins.delfino-core.dockerhub
exists in the pyproject.toml
:
delfino-docker
.pyproject.toml
, create a key tool.delfino.plugins.delfino-docker.docker_build
.tool.delfino.plugins.delfino-core.dockerhub
under this new key.username
to dockerhub_username
.upload_to_pypi
and build_docker
extra dependency groups. Missing groups will be simply ignored during installation, so this is not a breaking change.twine
and packaging
in the all
group.dependencies-update
command:
dependencies-update
no longer prints out executed commands since delfino>=0.29.0
logs all executed commands in debug level. Use --log-level debug
to see them.format
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.git-python
is installed after it's use is attempted.poetry
in the dependencies-update
command.dependencies-update
for pipenv
.utils.execute_commands_group
will receive passed arguments as passed_args
from config, if they use the delfino.decorators.pass_args
decorator. Example:
[tool.delfino.plugins.delfino-core.lint-pylint]
pass_args = "--fail-under 0.9"
will pass --fail-under 0.9
to pylint
executed by lint-pylint
, which is in lint
group, which itself is in verify-all
group.utils.execute_commands_group
logs a debug message when a command is not executed because it is disabled.pytest
with extra modules via the tool.delfino.plugins.delfino-core.pytest_modules
config.pytest
with extra modules via tool.delfino.plugins.delfino-core.pytest_modules
config. Each value in this list will prepend pytest
with -m <MODULE NAME>
.lint
command group can be overriden with tool.delfino.plugins.delfino-core.lint_commands
option in the pyproject.toml
file.PYTHONPATH
environment variable in tests.test
, which is the same as test-all
but without coverage.typecheck
will print additional headings if any folders are in a strict mode.test-unit
and test-integration
no longer support the --maxfail
and --debug
flags. Use the passthrough option (any argument after --
) to pass these flags to pytest directly with --maxfail
and -s
respectively.test-all
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.passed_args
.lint
, lint-pylint
, lint-pydocstyle
and lint-pycodestyle
commands takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.--
, which are then passed to the underlying tool:
lint-pycodestyle
lint-pydocstyle
lint-pylint
test-integration
test-unit
typecheck
dependencies-update
and optional dependency group dependencies_update
.build-docker
of cargo
on ARMv7 in emulator.typecheck
no longer accepts an arbitrary list of arguments interpreted as list of files to use. Use -f
/--file
/--folder
instead. This option must be repeated for multiple files/folders.delfino
to allow faster initial development.delfino
.delfino
.All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog
and this project adheres to Semantic Versioning.
Types of changes are:
delfino
version 3.x
, which requires pydantic>=2.0
.pyupgrade
incorrectly handling minor version number in tool.poetry.dependencies.python
of pyproject.toml
file.git push
if nothing was committed during dependencies-update
.--stash
(default) / --no-stash
option to dependencies-update
command to control whether to stash changes before updating dependencies.local_commands_directory
from delfino
.pyupgrade
into the format
commandtwine
and packaging
.upload-to-pypi
command. No longer needed with Poetry and Packagecloud uses a different upload mechanism.build-docker
command into a new plugin delfino-docker
as docker-build
.Have a look in the pyproject.toml
file. If upload-to-pypi
or build-docker
are listed under tool.delfino.plugins.delfino-core.disable_plugins
, remove them. You don't need to do anything else.
If tool.delfino.plugins.delfino-core.dockerhub
exists in the pyproject.toml
:
delfino-docker
.pyproject.toml
, create a key tool.delfino.plugins.delfino-docker.docker_build
.tool.delfino.plugins.delfino-core.dockerhub
under this new key.username
to dockerhub_username
.upload_to_pypi
and build_docker
extra dependency groups. Missing groups will be simply ignored during installation, so this is not a breaking change.twine
and packaging
in the all
group.dependencies-update
command:
dependencies-update
no longer prints out executed commands since delfino>=0.29.0
logs all executed commands in debug level. Use --log-level debug
to see them.format
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.git-python
is installed after it's use is attempted.poetry
in the dependencies-update
command.dependencies-update
for pipenv
.utils.execute_commands_group
will receive passed arguments as passed_args
from config, if they use the delfino.decorators.pass_args
decorator. Example:
[tool.delfino.plugins.delfino-core.lint-pylint]
pass_args = "--fail-under 0.9"
will pass --fail-under 0.9
to pylint
executed by lint-pylint
, which is in lint
group, which itself is in verify-all
group.utils.execute_commands_group
logs a debug message when a command is not executed because it is disabled.pytest
with extra modules via the tool.delfino.plugins.delfino-core.pytest_modules
config.pytest
with extra modules via tool.delfino.plugins.delfino-core.pytest_modules
config. Each value in this list will prepend pytest
with -m <MODULE NAME>
.lint
command group can be overriden with tool.delfino.plugins.delfino-core.lint_commands
option in the pyproject.toml
file.PYTHONPATH
environment variable in tests.test
, which is the same as test-all
but without coverage.typecheck
will print additional headings if any folders are in a strict mode.test-unit
and test-integration
no longer support the --maxfail
and --debug
flags. Use the passthrough option (any argument after --
) to pass these flags to pytest directly with --maxfail
and -s
respectively.test-all
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.passed_args
.lint
, lint-pylint
, lint-pydocstyle
and lint-pycodestyle
commands takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.--
, which are then passed to the underlying tool:
lint-pycodestyle
lint-pydocstyle
lint-pylint
test-integration
test-unit
typecheck
dependencies-update
and optional dependency group dependencies_update
.build-docker
of cargo
on ARMv7 in emulator.typecheck
no longer accepts an arbitrary list of arguments interpreted as list of files to use. Use -f
/--file
/--folder
instead. This option must be repeated for multiple files/folders.delfino
to allow faster initial development.delfino
.delfino
.All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog
and this project adheres to Semantic Versioning.
Types of changes are:
pyupgrade
incorrectly handling minor version number in tool.poetry.dependencies.python
of pyproject.toml
file.git push
if nothing was committed during dependencies-update
.--stash
(default) / --no-stash
option to dependencies-update
command to control whether to stash changes before updating dependencies.local_commands_directory
from delfino
.pyupgrade
into the format
commandtwine
and packaging
.upload-to-pypi
command. No longer needed with Poetry and Packagecloud uses a different upload mechanism.build-docker
command into a new plugin delfino-docker
as docker-build
.Have a look in the pyproject.toml
file. If upload-to-pypi
or build-docker
are listed under tool.delfino.plugins.delfino-core.disable_plugins
, remove them. You don't need to do anything else.
If tool.delfino.plugins.delfino-core.dockerhub
exists in the pyproject.toml
:
delfino-docker
.pyproject.toml
, create a key tool.delfino.plugins.delfino-docker.docker_build
.tool.delfino.plugins.delfino-core.dockerhub
under this new key.username
to dockerhub_username
.upload_to_pypi
and build_docker
extra dependency groups. Missing groups will be simply ignored during installation, so this is not a breaking change.twine
and packaging
in the all
group.dependencies-update
command:
dependencies-update
no longer prints out executed commands since delfino>=0.29.0
logs all executed commands in debug level. Use --log-level debug
to see them.format
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.git-python
is installed after it's use is attempted.poetry
in the dependencies-update
command.dependencies-update
for pipenv
.utils.execute_commands_group
will receive passed arguments as passed_args
from config, if they use the delfino.decorators.pass_args
decorator. Example:
[tool.delfino.plugins.delfino-core.lint-pylint]
pass_args = "--fail-under 0.9"
will pass --fail-under 0.9
to pylint
executed by lint-pylint
, which is in lint
group, which itself is in verify-all
group.utils.execute_commands_group
logs a debug message when a command is not executed because it is disabled.pytest
with extra modules via the tool.delfino.plugins.delfino-core.pytest_modules
config.pytest
with extra modules via tool.delfino.plugins.delfino-core.pytest_modules
config. Each value in this list will prepend pytest
with -m <MODULE NAME>
.lint
command group can be overriden with tool.delfino.plugins.delfino-core.lint_commands
option in the pyproject.toml
file.PYTHONPATH
environment variable in tests.test
, which is the same as test-all
but without coverage.typecheck
will print additional headings if any folders are in a strict mode.test-unit
and test-integration
no longer support the --maxfail
and --debug
flags. Use the passthrough option (any argument after --
) to pass these flags to pytest directly with --maxfail
and -s
respectively.test-all
command takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.passed_args
.lint
, lint-pylint
, lint-pydocstyle
and lint-pycodestyle
commands takes a list of one or more files/folders to use with the -f
/--file
/--folder
option.--
, which are then passed to the underlying tool:
lint-pycodestyle
lint-pydocstyle
lint-pylint
test-integration
test-unit
typecheck
dependencies-update
and optional dependency group dependencies_update
.build-docker
of cargo
on ARMv7 in emulator.typecheck
no longer accepts an arbitrary list of arguments interpreted as list of files to use. Use -f
/--file
/--folder
instead. This option must be repeated for multiple files/folders.delfino
to allow faster initial development.delfino
.delfino
.