0.11.0

🚀 New Features

• This release adds a new --show option to the usethis badge interface. This option will display the badge as markdown output without adding it to the README file.

🐞 Bug Fixes

• The --quiet option did not properly suppress output when displaying warnings associated with failed README parsing in usethis badge. This has been fixed.

• Due to a breaking change in Click v8.2.0, Click is now declared as a direct dependency temporarily until the ramifications can be addressed in Typer. The lower bound is declared as >=8.0.0 and the constraint !=8.2.0 to avoid the breaking change. For more information, see here.

🧹 Maintenance

• The latest version of the Bitbucket Pipelines configuration file schema is now supported, specifically support for new options available regarding artifact uploads.

📚 Documentation

• There have been various improvements to the documentation, especially the contribution guide.

🔧 Internal Changes

• Minor improvements to the CI configuration have been made; the CI will no longer trigger for changes to markdown files only, and --break-system-packages is no longer used.

What's Changed

• Add Commits since latest release badge by @nathanjmcdougall in #600
• Add more detailed instructions for running in isolation by @nathanjmcdougall in #601
• Delete docs/lessons.md by @nathanjmcdougall in #607
• Explain need for extra guidance for some issues by @nathanjmcdougall in #608
• Update bitbucket schema by @nathanjmcdougall in #613
• Try removing --break-system-packages in ci.yml by @nathanjmcdougall in #612
• Add a --show flag for usethis badge by @Z-Fran in #605
• Don't trigger CI for changes to markdown files only by @nathanjmcdougall in #615
• 610 never use simple print by @nathanjmcdougall in #614
• Add some information about writing tests to CONTRIBUTING.md by @nathanjmcdougall in #616
• Document jaraco/skeleton as a template alternative by @nathanjmcdougall in #617
• Explain pre-commit in CONTRIBUTING.md by @nathanjmcdougall in #618
• Add more hyperlinks and examples to the README by @nathanjmcdougall in #620
• Document usethis badge --show by @nathanjmcdougall in #626
• Add exclusion on click dependency by @nathanjmcdougall in #625
• Add changelog for v0.11.0 by @nathanjmcdougall in #627

New Contributors

• @Z-Fran made their first contribution in #605

Full Changelog: v0.10.0...v0.11.0

0.10.0

What's Changed

• 311 implement a rule management interface by @nathanjmcdougall in #540
• Create .readthedocs.yaml by @nathanjmcdougall in #584
• Add documentation requirements.txt file for readthedocs by @nathanjmcdougall in #585
• Point ReadTheDocs to the requirements file by @nathanjmcdougall in #586
• Sync README with CLI help docs by @nathanjmcdougall in #587
• Update docstring in _vary_network_conn by @nathanjmcdougall in #588
• Add informal development roadmap to README by @nathanjmcdougall in #589
• Don't add --showlocals by default for pytest by @nathanjmcdougall in #591
• Create CONTRIBUTING.md by @nathanjmcdougall in #592
• Move to Alpha development status by @nathanjmcdougall in #594
• Add changelog by @nathanjmcdougall in #595
• 437 add a how flag for tools by @nathanjmcdougall in #593
• Bump Jinja2 as per dependabot CVE-2025-27516 by @nathanjmcdougall in #598
• Add disclaimer about the experimental nature of updating existing projects by @nathanjmcdougall in #599

Full Changelog: v0.9.3...v0.10.0

0.9.3

What's Changed

• Fix typo in docstring in _tool.py by @nathanjmcdougall in #566
• Add TypeAlias for rules by @nathanjmcdougall in #567
• Create a unified RuleConfig abstraction by @nathanjmcdougall in #569
• Disable install completions by @nathanjmcdougall in #570
• Add rich help panels to CLI by @nathanjmcdougall in #572
• Refactor _tool.py into separate modules by @nathanjmcdougall in #573
• Fix incorrect toml_document variable name by @nathanjmcdougall in #577
• 558 usethis tool coverage breaks existing config in some cases by @nathanjmcdougall in #560

Full Changelog: v0.9.2...v0.9.3

0.9.2

What's Changed

• Update ci.yml by @nathanjmcdougall in #334
• Revert "Update ci.yml (#334)" by @nathanjmcdougall in #556
• Correctly document edge case for "first" resolution strategy where pr… by @nathanjmcdougall in #548
• Implement correct resolution strategy for codespell by @nathanjmcdougall in #547

Full Changelog: v0.9.1...v0.9.2

0.9.1

What's Changed

• Update README.md with usethis tool import-linter by @nathanjmcdougall in #530
• Test codespell message isn't duplicated. by @nathanjmcdougall in #531
• Enable the fly rule by default by @nathanjmcdougall in #533
• Remove header in usethis list by @nathanjmcdougall in #532
• Disclaim that uv is relied on in some cases in README by @nathanjmcdougall in #536
• Add pythonpath config to pytest if necessary by @nathanjmcdougall in #534
• Add support for uv.toml by @nathanjmcdougall in #538
• Disable EM rule by @nathanjmcdougall in #539

Full Changelog: v0.9.0...v0.9.1

0.9.0

What's Changed

• 98 implement usethis tool import linter by @nathanjmcdougall in #528

Full Changelog: v0.8.1...v0.9.0

0.8.1

What's Changed

• Bump ruff and pyright by @nathanjmcdougall in #514
• Add doctest config for pytest by @nathanjmcdougall in #515
• Add Key type alias for str in UsethisFileManager by @nathanjmcdougall in #517
• Support Sequence[Key] instead of list[Key] by @nathanjmcdougall in #519
• Add print_keys function by @nathanjmcdougall in #521
• Provide support for ConfigItem to manage a regex pattern of keys by @nathanjmcdougall in #522
• 525 adding to an ini file without a final newline breaks config by @nathanjmcdougall in #526

Full Changelog: v0.8.0...v0.8.1

0.8.0

What's Changed

• Try and restore codecov settings by @nathanjmcdougall in #446
• Creating shields.io badge by @clockback in #448
• Add usethis badge to README.md by @clockback in #450
• Add usethis badge to README.md by @nathanjmcdougall in #452
• Implement usethis badge usethis by @clockback in #451
• Remove Ruff badge from README.md by @nathanjmcdougall in #454
• Add a function to get layered architectures by @nathanjmcdougall in #459
• Add pre-commits to sync lockfile by @nathanjmcdougall in #461
• Move YAML format hint into YAML integration by @nathanjmcdougall in #463
• Add uv badge and badge tests by @nathanjmcdougall in #460
• Update README.md with new badges by @nathanjmcdougall in #466
• Added Emojis! by @Diparna in #473
• Remove 🐍 from README header by @nathanjmcdougall in #474
• 113 give examples of similar projects by @nathanjmcdougall in #475
• Grammar in README.md by @nathanjmcdougall in #478
• Ignore docs and README.md in CI by @nathanjmcdougall in #480
• Change codecov configuration to allow small drops in code coverage by @nathanjmcdougall in #479
• Update README.md with usethis show sonarqube by @nathanjmcdougall in #481
• Update README.md by @nathanjmcdougall in #482
• Protect interfaces with typer.Exit by @nathanjmcdougall in #476
• Test README examples are up-to-date by @nathanjmcdougall in #484
• Add a rule management interface for deptry by @nathanjmcdougall in #487
• Add a function which gives a detected list of importable modules by @nathanjmcdougall in #488
• Use percentages in codecov.yaml by @nathanjmcdougall in #490
• 485 use case insensitive checking of whether bitbucket and pre commit names are equivalent by @nathanjmcdougall in #494
• Enable FIX002 and check alphabetical sort of ALL_TOOLS by @nathanjmcdougall in #496
• Use lazy definitions for config values by @nathanjmcdougall in #504
• 507 usethis docstyle uses ini conventions in toml file by @nathanjmcdougall in #510

New Contributors

• @clockback made their first contribution in #448
• @Diparna made their first contribution in #473

Full Changelog: v0.7.0...v0.8.0

0.7.0

What's Changed

• Add usethis docstyle interface by @nathanjmcdougall in #433
• 186 a way to set the project author by @nathanjmcdougall in #436
• Fix "how to use" messages to avoid needing environment activation by @nathanjmcdougall in #438
• 435 implement a usethis list interface by @nathanjmcdougall in #439
• Rename to usethis show sonarqube by @nathanjmcdougall in #441

Full Changelog: v0.6.1...v0.7.0

0.6.1

What's Changed

• Update README with TOC for CLI by @nathanjmcdougall in #422
• Fix bugs in handling of ruff config and rules by @nathanjmcdougall in #421
• Don't hard fail if README not found for badges by @nathanjmcdougall in #425
• Add a simple codecov.yml by @nathanjmcdougall in #423
• Fix source dtype in coverage config by @nathanjmcdougall in #427
• Rename codecov.yml to codecov.yaml by @nathanjmcdougall in #428
• Create convenience methods for bitbucket config updates by @nathanjmcdougall in #431

Full Changelog: v0.6.0...v0.6.1