Cloup

Latest version: v3.0.5

Safety actively analyzes 688823 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

Page 4 of 5

0.6.1

===================
This patch release fixes some problems in the management and releasing of
the package.

- Add a ``py.typed`` file to ship the package with type hints (PEP 561).
- Use ``setuptools-scm`` to automatically manage the version of the package
*and* the content of the source distribution based on the git repository:

* the source distribution now matches the git repository, with the only
exception of ``_version.py``, which is not tracked by git; it's generated by
``setuptools-scm`` and included in the package;

* tox.ini and Makefile were updated to account for the fact that ``_version.py``
doesn't exist in the repository before installing the package.

- The new attribute ``cloup.__version_tuple__`` stores the version as a tuple
(of *at least* 3 elements).

0.6.0

===================

New features and enhancements
-----------------------------
- Slightly improved return type (hint) of command decorators.
- Minor refactoring of ConstraintMixin.
- Improved the documentation.

Breaking changes
----------------
- Removed the deprecated ``GroupSection`` as previously announced.
Use the new name instead: ``Section``.
- In ``Group.group()`` and ``Group.command``, the argument ``section`` was moved
after the ``cls`` argument so that the signatures are now fully compatible with
those of the parent class (the Liskov substitution principle is now satisfied).
If you (wisely) passed ``section`` and ``cls`` as keyword arguments in your
code, you don't need to change anything.

--------------------------------------------------------------------------------

0.5.0

===================
Requirements
------------
- Drop support to Python 3.5.

New features and enhancements
-----------------------------
- Added a subpackage for defining **constraints** on parameters groups
(including ``OptionGroup``'s).
- The code for adding support to option groups was extracted to ``OptionGroupMixin``.
- Most of the code for adding support to subcommand sections was extracted to
``SectionMixin``.

Deprecated
----------
- ``GroupSection`` was renamed as ``Section``.

Project changes
---------------
- Migrated from TravisCI to GitHub Actions.

--------------------------------------------------------------------------------

0.4.0

===================

Requirements
------------
- This is the last release officially supporting Python 3.5.

New features and enhancements
-----------------------------
- Changed the internal (non-public) structure of the package.
- Minor code improvements.

Project changes
---------------
- New documentation (hosted by ReadTheDocs)
- Tox, TravisCI, Makefile completely rewritten.

--------------------------------------------------------------------------------

0.3.0

===================
Breaking changes
----------------
- ``option_groups`` decorator now takes options as positional arguments ``*options``;
- ``Group.section`` decorator now takes sections as positional arguments ``*sections``;
- ``align_sections_help`` was renamed to ``align_sections``;
- ``GroupSection.__init__() sorted_`` argument was renamed to ``sorted``.

Other changes
-------------
- Additional signature for ``option_group``: you can pass the ``help`` argument
as 2nd positional argument.
- Aligned option groups (option ``align_option_groups`` with default ``True``).
- More refactoring and testing.

--------------------------------------------------------------------------------

0.2.0

===================
- [Feature] Add possibility of organizing subcommands of a cloup.Group in
multiple help sections.
- Various code improvements.
- Backward incompatible change:
- rename ``CloupCommand`` and ``CloupGroup`` resp. to just ``Command`` and ``Group``.

--------------------------------------------------------------------------------

Page 4 of 5

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.