Skip to content

Releases: alexreg/typer-cloup

0.11.0

25 Jan 04:33
Compare
Choose a tag to compare

Features

  • ✨ Allow manual specification of Click ParamType for parameters
  • ✨ Add VersionOption function for creating --version option
  • ✨ Remove support for installation of shell completion

Fixes

  • 🐛 Fix initializer of Context class
  • 🐛 Fix minor issues with resolving and displaying of parameter env vars
  • 🐛 Fix name attribute of ShellQuotedList class

Docs

  • 📝 Add more API docs
  • 📝 Miscellaneous improvements to docs
  • 🎨 Adjust spacing after ellipses in documentation

0.10.0

27 Dec 04:08
Compare
Choose a tag to compare

Features

  • ✨ Improve handling of environment variables for parameters
  • ✨ Use Click shell completion scripts
  • ✨ Remove support for PowerShell completion
  • ✨ Add support for shell-quoted list parameter type
  • ✨ Add support for unprocessed parameters

Docs

  • 📝 Add note about this fork to main page / README
  • 📝 Add more API docs

Internal

0.9.1

26 Nov 04:12
Compare
Choose a tag to compare

Internal

  • 📝 Miscellaneous improvements to docs
  • ✨ Fix Flake8 issues in codebase
  • ⬆️ Update dependency pytest-xdist
  • ✏ Fix comment in scripts/test.sh
  • ⬆ pre-commit autoupdate

0.9.0

24 Nov 18:17
Compare
Choose a tag to compare

Features

  • ✨ Rename Typer.add_typer to Typer.add_sub
  • ✨ Apply convertors to Context.params
  • ✨ Rename get_cloup_param to get_click_param and fix type hints

Fixes

  • 🐛 Reorder positional args of add_typer, callback, command methods of Typer
  • 🐛 Make TyperGroup inherit TyperCommand

Docs

  • ✏ Fix links to GitHub repo in docs

Internal

  • 📝 Reformat project metadata

0.8.0

15 Nov 16:45
Compare
Choose a tag to compare

Features

  • 🔧 Rename package module to typer_cloup

Docs

  • ✏ Fix links in docs

Internal

  • 👷 Fix definitions of manual inputs in GitHub workflows
  • ⬆️ Update dependency cloup to 2.0.0
  • 🔧 Update scripts

0.7.0

13 Nov 00:43
Compare
Choose a tag to compare

Fixes

  • ✏ Improve error messages
  • ✨ Improve efficiency of Typer.invoke and Typer.forward methods
  • 🐛 Use typer.Context as command context class
  • 🔧 Fix type hints
  • 🐛 Restore accidentally removed test test_others::test_autocompletion_too_many_parameters
  • 🐛 Fix get_param_completion function

Docs

  • ✏️ Fix typo in datetime docs. PR #495 by @huxuan.
  • ✏️ Add quotes to package name that includes brackets in docs. PR #475 by @gjolga.

Internal

  • ⬆ Bump dawidd6/action-download-artifact from 2.24.1 to 2.24.2. PR #494 by @dependabot[bot].
  • ⬆ Bump dawidd6/action-download-artifact from 2.9.0 to 2.24.1. PR #491 by @dependabot[bot].
  • 👷‍♂️ Ensure the PYTHONPATH is set properly when testing the tutorial scripts. PR #407 by @theMarix.
  • ✅ Add tests for complete coverage
  • ⬆️ Update dependency cloup to 1.0.0
  • 🔥 Remove tests/test_compat
  • 🔧 Remove "Commit to Help" section from issue templates
  • ✅ Add pragma: no cover to various lines
  • 👷 Fix formatting of GitHub workflows

0.6.0

06 Nov 02:15
Compare
Choose a tag to compare

Features

  • ✨ Make typer.run() not add completion scripts by default, it only makes sense in installed apps. PR #488 by @tiangolo.
  • ✨ Add support for Python 3.11, tests in CI and official marker. PR #487 by @tiangolo.

Docs

  • 📝 Add note about how subcommands with function names using underscores are converted to dashes. PR #403 by @targhs.
  • ✏ Fix link in docs to datetime.strptime(). PR #464 by @Kobu.
  • ✏ Update first-steps.md, clarify distinction between parameter and argument. PR #176 by @mccarthysean.

Internal

  • ✅ Add extra tests just for coverage because monkeypatching with strange imports confuses coverage. PR #490 by @tiangolo.
  • 📝 Add docs for deprecating commands (fastapi#419)
  • 🔧 Tweak pytest coverage. PR #485 by @tiangolo.
  • ➕ Bring back pytest-cov because coverage can't detect pytest-xdist. PR #484 by @tiangolo.
  • ⬆ [pre-commit.ci] pre-commit autoupdate. PR #411 by @pre-commit-ci[bot].
  • ⬆ Bump nwtgck/actions-netlify from 1.1.5 to 1.2.4. PR #479 by @dependabot[bot].
  • ⬆ Bump tiangolo/issue-manager from 0.2.0 to 0.4.0. PR #481 by @dependabot[bot].
  • 👷 Move from pytest-cov to coverage and Codecov to Smokeshow. PR #483 by @tiangolo.
  • ➕ Add extra Material for MkDocs deps for docs. PR #482 by @tiangolo.
  • 🔧 Update Dependabot config. PR #476 by @tiangolo.

0.5.1

21 Oct 17:47
Compare
Choose a tag to compare

Fixes

  • 🐛 Allow docutils dependency to be absent

Docs

  • 📝 Do not prefix calls with python -m when unnecessary
  • 📝 Update copyright in license
  • ✏ Remove hyphen in main page / README
  • ✏ Fix indentation in main page / README

Internal

  • 🔧 Sort gitignore entries
  • 👷 Update versions of actions in GitHub workflows
  • 📝 Update project metadata
  • 🔧 Replace pragma: nocover with pragma: no cover
  • ✨ Use docstring-parser package to parse help text
  • 📝 Update package name in main page / README

0.5.0

09 Aug 00:10
Compare
Choose a tag to compare

This release changes the dependency from Click to Cloup, which is based on the former package but adds support for option groups, constraints, subcommand aliases, subcommand sections, and other features.

Features

  • ✨ Add support for Cloup sections
  • ✨ Add support for Cloup aliases
  • ✨ Add support for Cloup decorator & manual constraints
  • ✨ Add support for Cloup option groups
  • ✨ Get help for params from docstrings
  • ✨ Add Typer.invoke and Typer.forward methods.
  • ✨ Drop support for Python 3.6.
  • ✨ Drop support for Click 7.

Fixes

  • 🐛 Fix type signature of typer.main.get_group
  • 🐛 Fix type annotation of run function

Docs

  • 📝 Update docs to point to own site
  • ✏ Fix broken plac link. PR #275 by @mgielda.
  • ✏ Fix typo, "ASCII codes" to "ANSI escape sequences". PR #308 by @septatrix.

Internal

  • 📝 Update project metadata
  • 🔧 Fix type checking
  • ✨ Use Cloup subclasses of Click types where appropriate
  • 👷 Fix building docs
  • 👷 Fix formatting of GitHub workflows
  • 👷 Fix build-docs GitHub workflow
  • ✨ Add test for issue fastapi#365
  • ✨ Add test for issue fastapi#208
  • ⬆️ Update dependencies
  • ⬆️ Upgrade codecov GitHub Action. PR #420 by @tiangolo.