Skip to content

Releases: usethis-python/usethis-python

0.20.0

25 Mar 20:58
@nathanjmcdougall nathanjmcdougall
Immutable release. Only release title and notes can be modified.
v0.20.0
e958469
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
0.20.0 Latest
Latest

💥 Changes

  • The usethis ci command (and usethis ci bitbucket subcommand) has been removed, including all related code and documentation. The rationale is documented at this page of the documentation site; also see #1313.
  • The --pre-commit option for usethis init has been renamed to --hook to be more general and to align with the new usethis hook command. This is partly in view of providing support for other Git hook tools in the future (specifically; prek).

🚀 New Features

  • There is now a usethis tool ty command to manage the ty type checker from Astral. There is also a higher-level usethis typecheck command which has the same effect, and an opt-in --typecheck option for usethis init. There is also an associated usethis badge ty command to add a badge for ty to the README.
  • There is now a usethis arch command to manage architecture analysis tools such as Import Linter; currently this wraps usethis tool import-linter. There is also an opt-in --arch option for usethis init.
  • There is now a usethis hook command to manage Git hook tools; currently this wraps usethis tool pre-commit. There is also an opt-in --hook option for usethis init.
  • usethis init now accepts a --build-backend option to specify the build backend to use in the generated pyproject.toml file. By default, the build backend is hatch (equivalent to --build-backend=hatch), but uv_build is also supported via --build-backend=uv.
  • The usethis show sonarqube command is now considered ready for use. It now supports a --project-key option to specify the SonarQube project key, in addition to the previous method of using a dedicated tool.usethis.sonarqube.project-key configuration in pyproject.toml.
  • Ruff rule hierarchies are now respected. For example, when "ALL" is selected, then other rules won't be explicitly added to the select list. Similarly, if "F" is ignored, then "F401" won't be explicitly ignored.

🐞 Bug Fixes

  • Read-only operations on YAML files will no longer modify the file with cosmetic changes. There should also be a small performance improvement associated with avoiding unnecessary writes. It was incorrectly reported that this issue was fully resolved in v0.17.0, and the release notes have been retrospectively updated accordingly.

🦾 Robustness

  • Submodules named _version.py in project packages will now be automatically excluded from the inferred Import Linter contracts, since these are often dynamically generated via tools such as setuptools_scm and hatch-vcs, and are not typical modules.
  • The RUF059 Ruff rule (unused-unpacked-variable) is now ignored by default for the tests directory, since tests often include intentionally unused variables and the rule is overly strict in that context.

📚 Documentation

  • The various usethis show commands are now explicitly documented in the README.

📦 Packaging

  • The mergedeep dependency has been removed, since the package has been unmaintained since 2021.

🔧 Internal Changes

  • Import cycles have now been broken through the is_likely_used heuristic function which provides the canonical heuristic for determining whether a tool is used based on its ToolSpec. A lack of import cycles is now enforced by both Import Linter and basedpyright.
  • The config_spec method has been moved into ToolSpec to align more with the intention that ToolSpec corresponds to aspects of the tool specification which are unopinionated and are based on the inherent design of the tool (whereas the Tool subclass may involve various heuristics and opinionated decisions).
  • The Tool class is now marked as @final to discourage subclassing. Likewise, ToolSpec methods are protected with @final to avoid inadvertently overriding its methods in the Tool subclass. Similarly, the @override decorator is explicitly used for methods which are providing an override implementation of an abstract method from the base class in Tool implementation subclasses.
  • There is improved type compliance through the reduced use of typing.Any, especially for the KeyValueFileManager implementation. Some of this has been achieved through increased runtime validation with pydantic, which should improve the intelligibility of error messages when invalid data is encountered in configuration files such as pyproject.toml.
  • UsethisFileManager has been renamed to FileManager with view to pull the file manager logic into a separate dependency in the future (see #1256). To the same end, the usethis._io module containing the FileManager and KeyValueFileManager definitions has been consolidated into the usethis._file module, as well as the print_keys function and the Key type alias.
  • There is now a FileManager.revert() method to reduce the need to access private attributes. Various other internal methods have been renamed to promote them from private usage to better reflect their usage.
  • FileManager and KeyValueFileManager are now explicitly marked as abstract base classes.
  • All typer.Option objects now reside in a central module at usethis._ui.options. This helps bring consistency within modules and helps bring attention to potential duplication of options across modules to improve the overall consistency of the CLI.
  • There is now a central usethis._fallback module for fallback versions of various packages. These provide the hard-coded values which are used when dynamic inference is not possible, such as when a backend such as uv is unavailable, or when populating pre-commit configuration.
  • codecov and codspeed workflows no longer run for doc-only changes.
  • There are now linters and formatters for markdown (enforced via prek). This is mostly to help facilitate the development and maintenance of agent skills.

What's Changed

  • Bump actions/upload-artifact and actions/download-artifact by @nathanjmcdougall in #1426
  • pkg._version should be added to exhaustive_ignores in Import Lint… by @nathanjmcdougall in #1427
  • 1415 doc why doesnt usethis support automated setup of ci config by @nathanjmcdougall in #1428
  • Move config_spec into ToolSpec by @Copilot in #1430
  • Add @final to all methods in ToolSpec and Tool implementations by @Copilot in #1432
  • Explain how to maintain docs in agent skills by @nathanjmcdougall in #1435
  • Remove import cycles by @nathanjmcdougall in #1436
  • Remove mergedeep dependency by @Copilot in #1437
  • Use __getitem__ -> object instead of __getitem__ -> Any in FileManagers by @nathanjmcdougall in #1439
  • enable reportMissingTypeStubs in basedpyright by @nathanjmcdougall in #1441
  • enable reportInvalidAbstractMethod in basedpyright by @nathanjmcdougall in #1442
  • Remove deprecated usethis ci from README and docs by @Copilot in #1445
  • Reduce the use of typing.Any by @nathanjmcdougall in #1443
  • Implement usethis tool ty and usethis typecheck by @nathanjmcdougall in #1446
  • Improve the type annotation of empty container initializations by @nathanjmcdougall in #1447
  • 1329 enable reportunannotatedclassattribute in basedpyright by @nathanjmcdougall in #1448
  • Avoid branding of uv vs. uv in release notes/changelog by @Copilot in #1450
  • Enable reportImplicitOverride in basedpyright by @nathanjmcdougall in #1449
  • Update license badge to point to the GitHub license tab as a hyperlink by @nathanjmcdougall in #1452
  • Consolidate usethis._io into usethis._file as new modules by @nathanjmcdougall in #1457
  • Skip codecov and codspeed workflows for doc-only changes by @Copilot in #1456
  • Implement usethis arch command by @Copilot in #1451
  • [Breaking Change] Add usethis hook command and --hook/--no-hook to usethis init by @Copilot in #1454
  • Enable reportPrivateUsage in basedpyright by @nathanjmcdougall in #1460
  • Centralize CLI options/arguments arguments by @nathanjmcdougall in #1458
  • Implement usethis badge ty by @Copilot in #1462
  • Document usethis show subcommands in CLI overview page by @Copilot in #1461
  • Set acyclic siblings contract for development by @nathanjmcdougall in #1470
  • Add tests for Ruff dev deps not removed when using pre-commit by @Copilot in #1464
  • Add a ...
Read more

Contributors

nathanjmcdougall
Assets 3
Loading

0.19.0

20 Mar 01:57
@nathanjmcdougall nathanjmcdougall
Immutable release. Only release title and notes can be modified.
v0.19.0
c22b6bd
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
0.19.0

🚧 Deprecations

  • The usethis ci bitbucket command, and the usethis ci command in general, are deprecated. Their removal is planned for usethis 0.20.0. For feedback and discussion, please see #1313.

🐞 Bug Fixes

  • Previously, parsing of pyproject.toml would fail on some Unicode characters. This has been fixed by specifying the encoding explicitly.

🧹 Maintenance

  • The latest version of the Bitbucket Pipelines configuration file schema is now supported, specifically source import pipelines (in addition to the legacy inline import pipelines).

📚 Documentation

  • There is now documentation on how to add a new tool to usethis in CONTRIBUTING.md.
  • There is now clearer guidance in CONTRIBUTING.md regarding the use of docstrings in the test suite.
  • The Scientific Python Library Development Guide is now mentioned in the README.

🔧 Internal Changes

  • A bug in the pipeweld utility has been fixed. The bug did not functionally affect usethis, but involved incorrect insertion behaviour of Parallel components in the presence of empty Series branches.
  • As of uv version 0.9.9, uv supports the UV_NO_DEFAULT_GROUPS environment variable, which is now being used for CI configuration. This causes changes to tested behaviour of usethis, and so the lowest tested version of uv is now v0.9.9. Going forward, it is not recommended to use older versions of uv with usethis.
  • There are now various agent skills configured for agentic development.
  • There is now explicit environment configuration for the GitHub Copilot agent.
  • There are now separate GitHub Actions workflows for static checks, pytest, codspeed, and codecov analysis. This helps reduce the scope of permissions to repo secrets and generally simplifies things.
  • There is now a GitHub Actions workflow for manually triggering a version bump to a specific package (for development). This is mostly to improve the maintenance experience for addressing CVEs.
  • The Tool class now inherits from ToolSpec for the methods which do not involve dynamic inference.
  • Many methods on the Tool and ToolSpec classes have been renamed and reorganized for convenience, including the introduction of a ToolMeta abstraction for grouping basic tool metadata (name, documentation URL, etc.).
  • There is now a dedicated module for heuristics for detecting tool usage.
  • The logic for selecting CI vs. pre-commit is now abstracted into the Tool class instead of being repeated for individual tool implementations.
  • Various submodules of usethis._integrations have been promoted into their own higher level modules to accommodate these changes while preserving a layered architecture.
  • There are various improvements in type compliance via the enabling of various basedpyright rules which were previously disabled.

What's Changed

Read more

Contributors

nathanjmcdougall
Loading

0.18.1

01 Feb 23:07
@nathanjmcdougall nathanjmcdougall
Immutable release. Only release title and notes can be modified.
v0.18.1
5d9732d
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
0.18.1

🐞 Bug Fixes

  • usethis show commands will no longer hard-wrap outputs, which gave invalid results in some cases, e.g. when running usethis show sonarqube with long sonar.projectKey fields.

🦾 Robustness

  • Fallback icons (e.g. √, □, i, ×, !) for message icons (✔, ☐, ℹ, ✗, ⚠) are now used for terminals which don't support unicode.
  • Identical warnings will now never display twice for the same command.
  • When a backend is not being used, the inferred version of Python based on the current interpreter is now compared with the requires-python bounds from pyproject.toml. If there is a mismatch, a warning is now emitted.
  • The tomli dependency on codespell is only declared as a dependency for Python versions 3.10 and below, since for versions 3.11 onwards, codespell uses tomllib from the standard library. This is based on the requires-python bounds from pyproject.toml if available, otherwise by the current interpreter.

📦 Packaging

  • As per the notes for 0.16.0, Version 0.18.13 of ruamel.yaml introduced a regression relating to indentation. The new versions 0.19.0 and 0.19.1 of ruamel.yaml are now also excluded as dependency versions until this is addressed in a future release.

🔧 Internal Changes

  • Rule management logic is now abstracted into the Tool class, reducing duplication between the logic used for deptry and Ruff.
  • Import Linter contracts for development have been moved from pyproject.toml to .importlinter for tidiness.

What's Changed

Full Changelog: v0.18.0...v0.18.1

Contributors

nathanjmcdougall
Loading

0.18.0

30 Dec 20:43
@nathanjmcdougall nathanjmcdougall
Immutable release. Only release title and notes can be modified.
v0.18.0
75e61d4
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
0.18.0

💥 Changes

  • Previously, when available, uv would be used as a package manager backend when pyproject.toml existed, even if there was no lockfile. This was considered to have too many false positives for projects using different systems (e.g. setup.py with linter configuration in pyproject.toml). Now, in lieu of any other evidence such as [tool.uv] sections in pyproject.toml, the default is to use the --backend=none behaviour.
  • Previously, tools configured via pre-commit would not be declared as dev dependencies unless necessary, namely the tools codespell and pyproject-fmt. Now, they are always declared as dev dependencies (when using the uv package manager backend).

🚀 New Features

  • Import Linter contract inference via usethis tool import-linter now supports namespace packages.
  • The new .coveragerc.toml file introduced by Coverage.py in v7.13.0 is now supported by usethis.
  • The new pre-commit language alias of unsupported instead of system introduced in v4.4.0 is now used when the minimum version of pre-commit is declared via minimum_pre_commit_version at 4.4.0 or greater.
  • The default Coverage.py configuration now sets relative_files = true to use relative paths e.g. in XML coverage reports. This helps improve robustness when parsing coverage reports as artifacts between CI jobs.
  • By default, usethis will now explicitly include dev dependencies in requirements.txt export configuration when using usethis tool requirements.txt. Previously this was implicit via the editable install -e . declaration.
  • There is now a usethis show backend command which emits the inferred backend (currently; one of uv or none).

🐞 Bug Fixes

  • There are no longer fatal crashes while running usethis tool import-linter in the presence of empty directories in the source directory.
  • Root-level .py files (e.g. setup.py) are no longer considered packages for Import Linter contract inference when using usethis tool import-linter.

🦾 Robustness

  • A speedup of up to 30% has been achieved in some situations by using atomic writes (and reducing duplicated reads) for YAML files.
  • When using the uv backend, if pyproject.toml does not yet exist, it will not be created unnecessarily when running usethis tool requirements.txt.
  • Test directory-related ignores for Ruff config (i.e. referencing tests/**) are now only generated when the tests directory actually exists.
  • PT-code Ruff rules (relating to pytest) are explicitly ignored for non-tests directories.
  • Error messages for subprocess failures now emit the failing command for better diagnosability.
  • Subprocess failures for uv no longer emit the full pyproject.toml contents.

🧹 Maintenance

  • The latest version of the Bitbucket Pipelines configuration file schema is now supported, specifically support for new options available regarding pipeline triggers and self-hosted runners.

📚 Documentation

  • There is now dedicated guidance on the docs site for using usethis together with popular frameworks like Django, FastAPI, and Dagster.
  • A detailed example of usethis init has been pulled out the README into a dedicated docs page.
  • The license is now documented on the docs site (in addition to the LICENSE file).
  • Branding (colours, project naming) etc. is now documented in CONTRIBUTING.md.
  • There is now a favicon on the docs site.
  • There are now dedicated 404 pages for the docs site.
  • The correct URL is now used for the pyproject-fmt homepage.

📦 Packaging

  • As per the notes for 0.16.0, Version 0.18.13 of ruamel.yaml introduced a regression relating to indentation. The new version 0.18.17 of ruamel.yaml is now also excluded as a dependency version until this is addressed in a future release.

🔧 Internal Changes

  • As of uv version 0.8.18, uv now allows pyproject.toml to be missing [project] sections. This causes changes to tested behaviour of usethis, and so the lowest tested version of uv is now v0.8.18. Going forward, it is not recommended to use older versions of uv with usethis.
  • The GitHub Actions for publishing to PyPI now use separate build and publish steps to reduce the scope of publish token permissions.
  • CI pipelines are now triggered for all changes, including documentation-only changes, since documentation includes tested codeblocks.
  • Codspeed runners in CI now run on Python 3.13 to reduce duplication between Python 3.14 runners.
  • The config for prek now uses the priority option to enable concurrency between hooks.
  • The pyright-style type checker has been migrated from pyright to a similar alternative, basedpyright.

What's Changed

Read more

Contributors

nathanjmcdougall
Loading

0.17.0

09 Nov 00:57
@nathanjmcdougall nathanjmcdougall
Immutable release. Only release title and notes can be modified.
v0.17.0
a3596bd
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
0.17.0

🚀 New Features

  • The usethis ci bitbucket command will now automatically use parallelism between pipeline steps where possible.
  • The usethis ci bitbucket command now has a --no-matrix-python option to opt-out of generating a Python version matrix for CI pipelines, i.e. to only test against a single Python version.
  • The behaviour of --backend=none is now the default when Poetry is detected, and a warning is displayed. This would change in a future release when a Poetry backend is implemented.
  • The command usethis badge socket has been added, which adds a Socket badge to the README for your PyPI package, giving a security scan rating.

🐞 Bug Fixes

  • usethis tool import-linter will no longer add INP rules multiple times when run repeatedly.
  • The (undocumented) usethis show sonarqube command previously gave invalid config for flat directory structures; this has been fixed. Also, the command no longer creates a pyproject.toml file if it does not already exist.
  • When running usethis tool requirements.txt with --backend=none, the how-to-use message misleadingly implies that a pre-existing requirements.txt file would be modified; this message no longer displays in this case.
  • Read-only operations on YAML files will no longer modify the file with cosmetic changes in some cases. A full fix will be included in a future release.

🦾 Robustness

  • Unrecognized entries (i.e. not found in the JSON Schema Store) in .pre-commit-config.yaml and bitbucket-pipelines.yml files will no longer cause validation errors or be dropped. Other minor improvements to the schema validation logic have also been made to improve robustness when roundtripping files.
  • The usethis ci bitbucket command will add the pre-commit cache to pre-commit steps when using the --backend=none behaviour.
  • Running usethis init with --backend=none will now explicitly instruct the user about any dependencies that need to be managed manually.
  • References to Bitbucket Pipelines are now consistently capitalized and pluralized throughout the codebase.

📚 Documentation

  • The FAQ now explicitly explains whether uv is necessary to use usethis, and gives some guidance for Poetry users.
  • Instructions for implementing a new usethis badge command in usethis have been added to the CONTRIBUTING.md file.
  • Some instructions for how to diagnose slow pytest collection speeds are now in CONTRIBUTING.md.
  • There is now an acknowledgements section in the README.
  • The CONTRIBUTING.md file now explains how to run the CLI from within a temporary project directory.
  • The CONTRIBUTING.md file explicitly mentions that type annotations should not be included in docstrings.
  • The CONTRIBUTING.md file now explains the details of the usethis._config.usethis_config global state object.
  • All usethis tool commands are now explicitly enumerated in the README.
  • The README now explicitly links to the ReadTheDocs site.
  • The CLI Reference had issues with indentation of sub-bullet points; this has been resolved.
  • A few badges have been moved and added to the Development section of the README.

📦 Packaging

  • As per the notes for 0.16.0, Version 0.18.13 of ruamel.yaml introduced a regression relating to indentation. The new version 0.18.16 of ruamel.yaml is now also excluded as a dependency version until this is addressed in a future release.

🔧 Internal Changes

  • There is now a method Tool.default_command() to specify any CLI command associated with a tool, to reduce duplication across the codebase.
  • The ty type checker from Astral has been added, and now runs via pre-commit hooks. Pyright continues to be used in the CI, but not via pre-commit.
  • The zizmor CI runner no longer triggers for documentation-only changes.
  • There is now a copilot-instructions.md file to configure GitHub Copilot.
  • The test to ensure the docs stay synchronized with the README has been weakened and no longer hard-codes any content from the README. This should reduce the flakiness of this test for README-only changes.

What's Changed

Read more

Contributors

nathanjmcdougall
Loading

0.16.0

16 Oct 21:41
@nathanjmcdougall nathanjmcdougall
Immutable release. Only release title and notes can be modified.
v0.16.0
4c8ea73
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
0.16.0

0.16.0

🚀 New Features

  • Most commands now accept a --backend option to specify the package manager backend to use. Up to this point, uv was the only supported backend. Now, a --backend=none option is available to use usethis without uv. This is a step toward supporting other backends such as Poetry in the future. When unspecified, heuristics will be used to determine the backend.
  • The use of pyproject.toml in a project is no longer assumed or imposed on a project when not using the uv backend.
  • pre-commit configurations are now more conventional, preferring URL-based repo configuration instead of local repos with language: system. The previous behaviour was designed to ensure synchronization of versions between the uv lockfile and the pre-commit configuration, but this is now provided by the sync-with-uv pre-commit hook, which is added automatically when using pre-commit with uv.
  • When using usethis author, a message with the author's name is now outputted in the console.

🦾 Robustness

  • Pydantic warnings relating to deprecated access to the model_fields attribute on an instance should no longer occur.
  • The tool.deptry.ignore_notebooks configuration for deptry is set explicitly to the default value of false to hint that deptry is being used, and to hint on how to configure it.

🐞 Bug Fixes

  • Previously, the usethis ci bitbucket command would fail to add Import Linter configuration to the CI pipeline when import-linter was detected. This has been fixed.
  • The usethis badge pypi command would generate markdown with invalid syntax due to a stray < character. This has been fixed.

🧹 Maintenance

  • The default version of pyproject-fmt when used as a pre-commit has been bumped from v2.6.0 to v2.11.0.
  • The latest version of the Bitbucket Pipelines configuration file schema is now supported, specifically inline and custom pipeline step types; the input_variables configuration for steps, and the new name scoped for the artifacts upload type option unshared.

📚 Documentation

  • Hyperlinks in the README and CONTRIBUTING.md files now point to the stable documentation site (rather than the latest site).
  • The configurator project is now documented as a similar project in the README.

📦 Packaging

  • Python 3.14 is now formally supported.
  • click is no longer a direct dependency.
  • Version 0.18.13 of ruamel.yaml introduced a regression relating to indentation. This version, along with 0.18.14 and 0.18.15, are now excluded as dependency versions to avoid this issue until it is addressed in a future release.

🔧 Internal Changes

  • The CI configuration has been overhauled. uv is used in more conventional ways. A runner has been added for bleeding edge dependency versions. The CI now runs on a cron schedule. zizmor has been added for security scanning. Permissions are more tightly scoped and explained. All actions have been bumped to their latest versions.
  • The pre-commit hooks have been migrated to use prek rather than pre-commit for development.
  • pytest-sugar has been added for a more user-friendly test suite output, and pytest-emoji has been removed.

What's Changed

Full Changelog: v0.15.2...v0.16.0

Contributors

nathanjmcdougall
Loading

0.15.2

27 Jul 09:53
@nathanjmcdougall nathanjmcdougall
Immutable release. Only release title and notes can be modified.
v0.15.2
18a1da0
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
0.15.2

🦾 Robustness

  • Previously, empty .pre-commit-config.yaml files would cause errors, (since they are not considered valid by pre-commit). Now usethis will treat them as if they do not exist, and so will write new config to them if applicable, rather than raising a validation error for this case.

🐞 Bug Fixes

  • When subprocessing uv, the usethis init command will no longer use the default for --build-backend, and instead will always explicitly use hatch. This may change in the future if the default supported build backend for usethis becomes uv_build, which is the new default for uv v0.8.0. This change avoids creating broken config which mixes uv_build with hatch config.
  • When adding Import Linter while using Ruff, the INP rules are selected, but ignored for the tests directory. However, no message would be displayed in cases where those rules were already selected but not already ignored. Now, a message will be displayed in this case.

📚 Documentation

  • A documentation site is now available at https://usethis.readthedocs.io/en/stable/. The CLI Reference section has been moved there from the README. Other minor wording and clarity improvements have been made.
  • The CLI reference now mentions that usethis tool pre-commit will install hooks to Git.

🔧 Internal Changes

  • The doc dependency group is no longer a default group. This reduces the dependencies required on CI.

What's Changed

Full Changelog: v0.15.1...v0.15.2

Contributors

nathanjmcdougall
Loading

0.15.1

18 Jul 10:58
@nathanjmcdougall nathanjmcdougall
Immutable release. Only release title and notes can be modified.
v0.15.1
aa8cdcd
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
0.15.1

🐞 Bug Fixes

  • Previously, when using Import Linter with Ruff, the INP rule would be ignored in the tests directory via an incorrect glob pattern of "*/tests/**"; this has been fixed to "tests/**".
  • A TOML integration problem could cause broken configuration in some cases. This could occur on deeply nested keys, such as the per-file-ignores for Ruff directories in pyproject.toml when using Import Linter. This has now been fixed.

📚 Documentation

  • Some issues with mismatched bullet points in the CLI docs section of the README have been addressed.
  • The opening paragraph of the README has been reworded for clarity, and various other minor changes have been made.

🔧 Internal Changes

  • Changes to the CI and the test suite have been made to support uv v0.8.0. Newer features of uv are now required in the CI configuration, meaning the lowest tested version of uv is now v0.6.8. Going forward, it is not recommended to use older versions of uv with usethis.

What's Changed

Full Changelog: v0.15.0...v0.15.1

Contributors

nathanjmcdougall
Loading

0.15.0

15 Jul 11:42
@nathanjmcdougall nathanjmcdougall
Immutable release. Only release title and notes can be modified.
v0.15.0
a7b7eda
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
0.15.0

🚀 New Features

  • The usethis tool mkdocs command has been implemented to manage MkDocs documentation sites. Also, the higher-level usethis doc command has been added, which has the same effect.
  • The --doc option for usethis init has been implemented to initialize MkDocs documentation sites by default. The old behaviour can be restored by passing --no-doc.
  • Coverage.py for measuring test coverage is now included by default when using usethis test or usethis init with the default --test option. This provides out-of-the-box test coverage reporting.
  • The --frozen option is now supported in the usethis ci and usethis docstyle commands. Similar to other commands, this will leave the virtual environment and lockfile unchanged.
  • The --offline option is now supported in the usethis docstyle command. This will run the command without network access.

🦾 Robustness

  • Incorrectly structured TOML files will emit better messages and in some cases will be handled gracefully, specifically in cases where a non-mapping value is encountered where a mapping is expected.

📦 Packaging

  • Bounds are now placed on the build dependencies for usethis (i.e. hatch-vcs>=0.5.0,<0.6.0 and hatchling>=1.27.0,<1.28.0), which should improve reproducibility of builds in the long run.

🔧 Internal Changes

  • A YAMLFileManager has been implemented to manage YAML files, which is used for the MkDocs configuration file mkdocs.yml.
  • A new get_project_deps method has been added to retrieve core project dependencies from the pyproject.toml file, specifically from the project.dependencies section. This will be used in a future release to support non-uv based backends, such as Poetry.

What's Changed

Full Changelog: v0.14.2...v0.15.0

Contributors

nathanjmcdougall
Loading

0.14.2

08 Jul 20:52
@nathanjmcdougall nathanjmcdougall
Immutable release. Only release title and notes can be modified.
v0.14.2
06c14ff
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
0.14.2

🦾 Robustness

  • The heuristics to determine whether a tool is used will now check the pre-commit configuration to see whether there is a pre-commit hook for the tool.
  • When removing an entry of TOML configuration, usethis makes some effort to remove empty tables and sections. This was previously only done to one level of nesting, but it should now occur at multiple levels of nesting.

🐞 Bug Fixes

  • The Codespell configuration for pyproject.toml was giving invalid configuration for the ignore-words-list option, which was set to an empty list. Codespell requires this option to be non-empty. It is now set to ["..."], which is consistent with the handling for other INI-based configuration files.
  • Previously, using the --how option for usethis tool commands would not properly infer the way a tool was installed. For example, it would assume that a tool is installed as a pre-commit hook, simply because pre-commit was used for the project, without checking whether there actually are any hooks. This has been fixed, and more sophisticated heuristics are now used to determine how a tool is installed.
  • The message to suggest using __init__.py files when using Import Linter now checks explicitly whether you have the INP rules enabled in Ruff, rather than simply assuming that these rules would be enabled when Ruff is used. The message is only displayed if these INP rules are not enabled.
  • Error messages now use more consistent punctuation and formatting.

🧹 Maintenance

  • The default version of pyproject-fmt when used as a pre-commit has been bumped from v2.5.0 to v2.6.0.
  • The latest version of the Bitbucket Pipelines configuration file schema is now supported, specifically support for new options available regarding concurrency groups.

📚 Documentation

  • The FAQ is now included in the MkDocs build, and information about roundtripping is now included in the FAQ.
  • Social Icon buttons for GitHub and PyPI have been added to the bottom of the MkDocs site.

🔧 Internal Changes

  • Minor improvements to the CI configuration have been made; the CI will no longer trigger for changes to the MkDocs configuration files.
  • There is now global state to turn off pre-commit detection for pre-commit integrations, which is a step toward providing an interface to forbid adding a tool as a pre-commit.
  • In the previous release, the project moved to using the codspeed Walltime runner for CI benchmarks. This has been reverted back to using the GitHub-based codspeed runners, since the Walltime runner reports were not as detailed and there were usage limits.

What's Changed

Full Changelog: v0.14.1...v0.14.2

Contributors

nathanjmcdougall
Loading