Skip to content

v3.0.0

Compare
Choose a tag to compare
@fredrikaverpil fredrikaverpil released this 05 Oct 14:15
· 22 commits to main since this release

㊗️ Major (backwards-compat breaking changes)

  • Dropped Python 3.7 support.
  • Some CLI arguments have been renamed.
  • Certain CLI arguments must now be repeated rather than having multiple values supplied to one and the same argument.

For exact details on the CLI argument changes, see the migration guide (attached at the bottom of these release notes and in the README).

🐸 Minor (new features)

  • The ability to configure creosote using pyproject.toml (❤️🙏 @BrianPugh #183 hacktoberfest-accepted). See the README for more details.
  • Python 3.12 support.

🐞 Patch (bug fixes)

  • When excluding dependencies, there could be a falsy warning shown because the dependency name entered on the command line was not "canonicalized" (dashes and periods in package names are made into underscores internally).

🫁 Internal (test suite)

  • Overhauled test suite with better integration tests and better pytest fixtures. Hopefully the whole setup is a lot more approachable now.

🌀 Migration guide: creosote 2.x to 3.x

Creosote was updated to 3.0.0 because the way arguments were supplied has now changed. This also brings pyproject.toml configuration support.

Argument name change

The argument naming has changed:

2.x argument name 3.x argument name
--exclude-deps --exclude-dep
--paths --path
--sections --section

Multiple argument values

With creosote 2.x, you were able to provide multiple values following some arguments, example:

creosote -p file1.py file2.py

With creosote 3.x, you must now provide multiple arguments as a key/value pair:

creosote -p file1.py -p file2.py

This new creosote 3.x behavior applies to the following 3.x CLI arguments:

  • --venv
  • --exclude-dep
  • -p or --path
  • -s or --section