v3.0.0

🚨 Upgrade Notice

There are breaking changes between 2.x and 3.x, mostly involving shell tab completion. See the changelog for migration steps.

What's Changed

• Implemented Completer for media files.
• Implemented Completer for static files.
• Fixed Completions before the end of the typed command string do not work.
• Implemented Add print_return class field to enable/disable result printing
• BREAKING Default rich traceback should not show locals - its too much information.
• Implemented path completers should be configurable with a root directory other than cwd
• Implemented Migrate pyproject.toml to poetry 2 and portable project specifiers.
• BREAKING Split parsers.py and completers.py into submodules.
• Implemented Model completer/parser should support returning the field value
• Fixed Model objects with null lookup fields should not be included in model field completion output
• Implemented Add a performance regression.
• Implemented Use in-house shell completer classes.
• Implemented Add precommit hook to fix safe lint and format issues
• Fixed Fish shell complete is broken when rich is installed.
• BREAKING Remove name parameter from initialize()/callback().
• Implemented Run full test suite on mac osx
• Implemented Convert check.sh to justfile
• Implemented Run full test suite on windows in CI
• Implemented ANSI color control sequences should optionally be scrubbed from shell completions
• Fixed supressed_base_arguments are still present in the Context
• Implemented Add showcase of commands using django-typer to docs
• Implemented Add a @finalize decorator for functions to collect/operate on subroutine results.
• Fixed Remove management imports in django_typer/init.py
• Fixed ParamSpec includes self for group methods
• Fixed Installed shellcompletion scripts do not pass values of --settings or --pythonpath
• Implemented Add support for QuerySet parameter types.
• Fixed shellcompletion complete should print to the command's stdout.
• Implemented Add translations for helps..
• Implemented Add completer/parser for FileField and FilePathField
• Implemented Add completer/parser for DurationField
• Implemented Add completer/parser for DateTimeField
• Implemented Add completer/parser for DateField
• Implemented Add completer/parser for TimeField
• Implemented Improve shell completion continuous integration tests

Full Changelog: v2.6.0...v3.0.0

v2.6.0

• Fixed On Python 3.13, sometimes flush is called on the stream wrapped by OutputWrapper after it is closed.
• Implemented Support Typer 0.15.x

Full Changelog: v2.5.0...v2.6.0

v2.5.0

• Implemented Support Typer >=0.14
• Fixed Typer-style interface throws an assertion when no callback is present on a subgroup.

What's Changed

• V2.5 by @bckohan in #151

Full Changelog: v2.4.0...v2.5.0

v2.4.0

• Implemented Support Typer 0.13

What's Changed

• update scheduled actions to run weekly instead of daily by @bckohan in #135
• make linter happy by @bckohan in #136
• fix a few howto doc typos by @bckohan in #137
• fix #138 by @bckohan in #139

Full Changelog: v2.3.0...v2.4.0

v2.3.0

What's Changed

• Fixed Inheritance more than one level deep of TyperCommands does not work.
• Implemented Drop python 3.8 support.
• Implemented Command help order should respect definition order for class based commands.
• Fixed Overriding the command group class does not work.
• Completed Add project to test PyPI
• Completed Open up vulnerability reporting and add security policy.
• Completed Add example of custom plugin logic to plugins tutorial.
• Completed Move architecture in docs to ARCHITECTURE.md
• Completed Transfer to django-commons
• Completed Add howto for how to change the display order of commands in help.

New Contributors

• @github-actions made their first contribution in #118
• @tim-schilling made their first contribution in #127

Full Changelog: v2.2.2...v2.3.0

v2.2.2

• Implemented Support python 3.13
• Fixed typer > 0.12.5 toggles rich help renderings off by default

What's Changed

• V2.2.2 by @bckohan in #110

Full Changelog: v2.2.1...v2.2.2

v2.2.1

• Fixed Remove shell_complete monkey patch when upstream PR is merged.

What's Changed

• move to furo theme from sphinx rtd theme by @bckohan in #104
• fix comment size on howto example by @bckohan in #105
• V2.x.x by @bckohan in #106
• v2.2.1 by @bckohan in #107

Full Changelog: v2.2.0...v2.2.1

v2.2.0

• Implemented ModelObjectCompleter should optionally accept a QuerySet in place of a Model class.

What's Changed

• V2.x.x by @bckohan in #101
• fix groups app tree diagram by @bckohan in #102
• V2.2.0 by @bckohan in #103

Full Changelog: v2.1.3...v2.2.0

v2.1.3

• Fixed Move from django_typer to django_typer.management broke doc reference links.
• Implemented Support Django 5.1

What's Changed

• V2.x.x by @bckohan in #99
• add Django 5.1 classifier by @bckohan in #100

Full Changelog: v2.1.2...v2.1.3

v2.1.2

• Fixed Type hint kwargs to silence pylance warnings about partially unknown types

What's Changed

• fix #93, remove pylint pragmas by @bckohan in #94

Full Changelog: v2.1.1...v2.1.2