breakwise 0.1.0__tar.gz

breakwise-0.1.0/.gitignore

@@ -0,0 +1,226 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+*.lcov
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# uv
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs/Zensical documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore that
+#   can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, you
+#   could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# Node.js packages for the development tools
+node_modules/
+
+# Notices are never ignored, whatever their package is called.
+!notices/**

breakwise-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

breakwise-0.1.0/PKG-INFO

@@ -0,0 +1,54 @@
+Metadata-Version: 2.5
+Name: breakwise
+Version: 0.1.0
+Summary: Tested notices of breaking changes in Python libraries, and the tools that apply them.
+Project-URL: Repository, https://github.com/breakwise/breakwise
+Project-URL: Documentation, https://github.com/breakwise/breakwise/tree/main/docs
+Project-URL: Issues, https://github.com/breakwise/breakwise/issues
+License-Expression: Apache-2.0 AND CC-BY-4.0
+License-File: LICENSE
+License-File: notices/LICENSE.md
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.12
+Requires-Dist: pyyaml>=6.0.1
+Description-Content-Type: text/markdown
+
+# Breakwise
+
+An open registry of breaking changes in Python libraries, with tested fixes.
+
+Each breaking change is a small notice: the package, the release that breaks your code, and how to fix it.
+Every notice has a before-and-after example that runs on real releases from PyPI before it is accepted.
+
+## Install
+
+```sh
+pip install breakwise
+```
+
+## Show a notice
+
+```sh
+breakwise explain BW-2026-0001
+```
+
+This release comes with a copy of the notices, so it works offline.
+A command that finds the code an upgrade breaks comes next.
+
+## Links
+
+- [Repository](https://github.com/breakwise/breakwise)
+- [Notice format](https://github.com/breakwise/breakwise/blob/main/docs/notice-format.md)
+- [Architecture and roadmap](https://github.com/breakwise/breakwise/blob/main/docs/architecture.md)
+
+## License
+
+The code is licensed under Apache-2.0.
+The notices are licensed under CC BY 4.0: credit them as "Data from the Breakwise registry, CC BY 4.0".

breakwise-0.1.0/docs/pypi.md

@@ -0,0 +1,32 @@
+# Breakwise
+
+An open registry of breaking changes in Python libraries, with tested fixes.
+
+Each breaking change is a small notice: the package, the release that breaks your code, and how to fix it.
+Every notice has a before-and-after example that runs on real releases from PyPI before it is accepted.
+
+## Install
+
+```sh
+pip install breakwise
+```
+
+## Show a notice
+
+```sh
+breakwise explain BW-2026-0001
+```
+
+This release comes with a copy of the notices, so it works offline.
+A command that finds the code an upgrade breaks comes next.
+
+## Links
+
+- [Repository](https://github.com/breakwise/breakwise)
+- [Notice format](https://github.com/breakwise/breakwise/blob/main/docs/notice-format.md)
+- [Architecture and roadmap](https://github.com/breakwise/breakwise/blob/main/docs/architecture.md)
+
+## License
+
+The code is licensed under Apache-2.0.
+The notices are licensed under CC BY 4.0: credit them as "Data from the Breakwise registry, CC BY 4.0".

breakwise-0.1.0/notices/LICENSE.md

@@ -0,0 +1,13 @@
+# License for notices
+
+SPDX-License-Identifier: CC-BY-4.0
+
+The notices in this directory are licensed under the
+[Creative Commons Attribution 4.0 International License (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/legalcode.en).
+
+You may copy, share and adapt them for any purpose, including commercially,
+as long as you give credit (for example: "Data from the Breakwise registry, CC BY 4.0"),
+link to the license, and say if you changed anything.
+
+Everything else in this repository, including the schema in `schema/`,
+is licensed separately under [Apache-2.0](../LICENSE).

breakwise-0.1.0/notices/pypi/pydantic-ai/BW-2026-0001.yaml

@@ -0,0 +1,30 @@
+---
+schema_version: "0.1"
+id: BW-2026-0001
+status: verified
+published: "2026-10-21"
+modified: "2026-10-22"
+package:
+  ecosystem: PyPI
+  name: pydantic-ai
+  aliases:
+    - pydantic-ai-slim
+type: rename
+breaks_in: "2.0.0b1"
+works_since: "0.7.6"
+summary: OpenAIModel was renamed to OpenAIChatModel, and the old name was removed in 2.0.0b1.
+rename:
+  from: pydantic_ai.models.openai.OpenAIModel
+  to: pydantic_ai.models.openai.OpenAIChatModel
+example:
+  before: |
+    from pydantic_ai.models.openai import OpenAIModel
+
+    model = OpenAIModel("gpt-5")
+  after: |
+    from pydantic_ai.models.openai import OpenAIChatModel
+
+    model = OpenAIChatModel("gpt-5")
+references:
+  - https://pydantic.dev/docs/ai/changelog/
+  - https://github.com/pydantic/pydantic-ai/blob/v0.7.6/pydantic_ai_slim/pydantic_ai/models/openai.py

breakwise-0.1.0/pyproject.toml

@@ -0,0 +1,132 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "breakwise"
+dynamic = ["version"]
+description = "Tested notices of breaking changes in Python libraries, and the tools that apply them."
+readme = "docs/pypi.md"
+requires-python = ">=3.12"
+# The code is Apache-2.0, and the notices that come with it are CC BY 4.0.
+license = "Apache-2.0 AND CC-BY-4.0"
+license-files = ["LICENSE", "notices/LICENSE.md"]
+dependencies = ["pyyaml>=6.0.1"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+[project.urls]
+Repository = "https://github.com/breakwise/breakwise"
+Documentation = "https://github.com/breakwise/breakwise/tree/main/docs"
+Issues = "https://github.com/breakwise/breakwise/issues"
+
+[project.scripts]
+breakwise = "breakwise.cli:main"
+
+[tool.hatch.version]
+path = "src/breakwise/__init__.py"
+
+[tool.hatch.build.targets.sdist]
+only-include = ["src", "notices", "docs/pypi.md", "LICENSE"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/breakwise"]
+
+# The notices go into the package, next to where the index will go later.
+[tool.hatch.build.targets.wheel.force-include]
+"notices" = "breakwise/data/notices"
+
+# Settings for the development tools.
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["tools", "src"]
+addopts = ["-ra", "--strict-markers", "--strict-config"]
+filterwarnings = ["error"]
+
+[tool.coverage.run]
+branch = true
+source = ["tools", "src"]
+
+[tool.coverage.report]
+fail_under = 100
+show_missing = true
+skip_covered = true
+exclude_also = ['if __name__ == "__main__":']
+
+[tool.mypy]
+strict = true
+python_version = "3.12"
+mypy_path = "tools,src"
+files = ["tools", "src", "tests"]
+warn_unreachable = true
+enable_error_code = [
+    "ignore-without-code",
+    "possibly-undefined",
+    "redundant-expr",
+    "truthy-bool",
+    "truthy-iterable",
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py312"
+
+[tool.ruff.lint]
+select = [
+    "A",    # shadowed builtins
+    "ARG",  # unused arguments
+    "B",    # likely bugs
+    "BLE",  # blind except
+    "C4",   # comprehensions
+    "C90",  # complexity
+    "DTZ",  # dates without time zones
+    "E",    # pycodestyle errors
+    "F",    # pyflakes
+    "FURB", # modern idioms
+    "I",    # import order
+    "ISC",  # implicit string concatenation
+    "N",    # naming
+    "PERF", # performance
+    "PGH",  # blanket noqa and type: ignore
+    "PIE",
+    "PL",   # pylint
+    "PT",   # pytest style
+    "PTH",  # pathlib
+    "RET",  # return statements
+    "RUF",  # ruff
+    "S",    # security
+    "SIM",  # simplifications
+    "SLF",  # private access
+    "TRY",  # exception handling
+    "UP",   # pyupgrade
+    "W",    # pycodestyle warnings
+]
+# Messages are written where the error is raised, which keeps them readable.
+ignore = ["TRY003"]
+
+[tool.ruff.lint.mccabe]
+max-complexity = 10
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = [
+    "ARG",     # fakes take the arguments of what they replace
+    "PLR0913", # parametrized tests take many arguments
+    "PLR0917", # and take them by position
+    "PLR2004", # expected values are written inline
+    "S101",    # pytest uses assert
+    "S603",    # tests run subprocesses with fixed arguments
+    "S607",    # and find git on PATH
+    "SLF001",  # tests may call private helpers
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["breakwise", "validate_notices", "verify_examples"]

breakwise-0.1.0/src/breakwise/__init__.py

@@ -0,0 +1,3 @@
+"""Breakwise: tested notices of breaking changes in Python libraries."""
+
+__version__ = "0.1.0"

breakwise-0.1.0/src/breakwise/cli.py

@@ -0,0 +1,83 @@
+"""The ``breakwise`` command."""
+
+from __future__ import annotations
+
+import argparse
+import sys
+import textwrap
+from collections.abc import Sequence
+
+from breakwise import __version__
+from breakwise.notices import Notice, NoticeError, find
+
+ATTRIBUTION = "Data from the Breakwise registry, CC BY 4.0."
+
+
+def main(argv: Sequence[str] | None = None) -> int:
+    parser = argparse.ArgumentParser(
+        prog="breakwise", description="Breaking changes in Python libraries, with tested fixes."
+    )
+    parser.add_argument("--version", action="version", version=f"breakwise {__version__}")
+    commands = parser.add_subparsers(dest="command", required=True, metavar="COMMAND")
+    explain = commands.add_parser(
+        "explain", help="show a notice", description="Show a notice. This works offline."
+    )
+    explain.add_argument("notice_id", metavar="ID", help="a notice ID, such as BW-2026-0001")
+    args = parser.parse_args(argv)
+
+    try:
+        notice = find(args.notice_id)
+    except NoticeError as error:
+        print(f"breakwise: {error}", file=sys.stderr)
+        return 1
+    print(render(notice))
+    return 0
+
+
+def render(notice: Notice) -> str:
+    """The text that ``breakwise explain`` prints for a notice."""
+    data = notice.data
+    package = data["package"]
+    status = data["status"]
+    if status == "draft":
+        status = "draft, not yet checked by a maintainer"
+    where = f"{package['name']} on {package['ecosystem']}"
+    if package.get("aliases"):
+        where += f" (also {', '.join(package['aliases'])})"
+    change = data["type"]
+    if change == "rename":
+        change += f" {data['rename']['from']} -> {data['rename']['to']}"
+    if data.get("works_since"):
+        works_since = f"{data['works_since']}, so the fix can come before the upgrade"
+    else:
+        works_since = "not known, so the fix waits for the upgrade"
+
+    lines = [
+        f"{data['id']} ({status})",
+        data["summary"],
+        "",
+        f"Package:     {where}",
+        f"Change:      {change}",
+        f"Breaks in:   {data['breaks_in']}",
+        f"Works since: {works_since}",
+    ]
+    if "instructions" in data:
+        lines += ["", "Instructions:", _indent(data["instructions"])]
+    lines += [
+        "",
+        "Before:",
+        _indent(data["example"]["before"]),
+        "After:",
+        _indent(data["example"]["after"]),
+        "",
+        "References:",
+        *(f"  {reference}" for reference in data["references"]),
+        "",
+        f"Notice: {notice.url}",
+        ATTRIBUTION,
+    ]
+    return "\n".join(lines)
+
+
+def _indent(text: str) -> str:
+    return textwrap.indent(text.rstrip("\n"), "    ")

breakwise-0.1.0/src/breakwise/notices.py

@@ -0,0 +1,58 @@
+"""The notices that come with the package, read without network access."""
+
+from __future__ import annotations
+
+import re
+from dataclasses import dataclass
+from importlib import resources
+from importlib.resources.abc import Traversable
+from typing import Any
+
+import yaml
+
+from breakwise import __version__
+
+# Building the package copies the registry's notices/ folder here.
+DATA: Traversable = resources.files("breakwise") / "data" / "notices"
+REPOSITORY = "https://github.com/breakwise/breakwise"
+NOTICE_ID = re.compile(r"BW-[0-9]{4}-[0-9]{4,}")
+
+
+class NoticeError(Exception):
+    """A notice that can't be found."""
+
+
+@dataclass(frozen=True)
+class Notice:
+    """A notice and its place in the registry, such as ``pypi/pydantic-ai/BW-2026-0001.yaml``."""
+
+    data: dict[str, Any]
+    path: str
+
+    @property
+    def url(self) -> str:
+        """The notice's file on GitHub."""
+        return f"{REPOSITORY}/blob/main/notices/{self.path}"
+
+
+def find(notice_id: str, root: Traversable | None = None) -> Notice:
+    """Return a notice by its ID, from ``root`` or else from the notices in the package."""
+    if not NOTICE_ID.fullmatch(notice_id.upper()):
+        raise NoticeError(f"{notice_id!r} is not a notice ID. IDs look like BW-2026-0001.")
+    notice_id = notice_id.upper()
+    root = DATA if root is None else root
+    if not root.is_dir():
+        raise NoticeError("The notices that come with breakwise are missing. Reinstall breakwise.")
+    # A notice's file name is its ID, under notices/<ecosystem>/<package>/.
+    for ecosystem in root.iterdir():
+        if not ecosystem.is_dir():
+            continue
+        for package in ecosystem.iterdir():
+            file = package / f"{notice_id}.yaml"
+            if file.is_file():
+                data = yaml.safe_load(file.read_text(encoding="utf-8"))
+                return Notice(data, f"{ecosystem.name}/{package.name}/{file.name}")
+    raise NoticeError(
+        f"There is no notice {notice_id} in the notices that come with breakwise {__version__}. "
+        "A newer release may have it."
+    )