modelbump 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,162 @@
1
+ Metadata-Version: 2.4
2
+ Name: modelbump
3
+ Version: 0.1.0
4
+ Summary: Find the LLM model IDs in your code and config, and warn before providers retire them.
5
+ Keywords: llm,model deprecation,model retirement,static analysis,github action,openai,anthropic,gemini
6
+ Author: Hammad Hassan
7
+ License-Expression: Apache-2.0
8
+ License-File: LICENSE
9
+ Classifier: Development Status :: 3 - Alpha
10
+ Classifier: Environment :: Console
11
+ Classifier: Intended Audience :: Developers
12
+ Classifier: Operating System :: OS Independent
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Programming Language :: Python :: 3.12
15
+ Classifier: Programming Language :: Python :: 3.13
16
+ Classifier: Topic :: Software Development :: Quality Assurance
17
+ Classifier: Typing :: Typed
18
+ Requires-Dist: pydantic>=2.13
19
+ Requires-Dist: pyyaml>=6.0.3
20
+ Requires-Dist: tree-sitter>=0.26
21
+ Requires-Dist: tree-sitter-python>=0.25
22
+ Requires-Dist: tree-sitter-typescript>=0.23.2
23
+ Requires-Dist: typer>=0.27.3
24
+ Requires-Python: >=3.12
25
+ Project-URL: Homepage, https://github.com/imhammad/modelbump
26
+ Project-URL: Documentation, https://imhammad.github.io/modelbump/
27
+ Project-URL: Repository, https://github.com/imhammad/modelbump
28
+ Project-URL: Issues, https://github.com/imhammad/modelbump/issues
29
+ Project-URL: Changelog, https://github.com/imhammad/modelbump/blob/main/CHANGELOG.md
30
+ Description-Content-Type: text/markdown
31
+
32
+ # ModelBump
33
+
34
+ **Dependabot for LLM models.** ModelBump finds the AI models your code depends on and warns you before a provider retires them. Later versions will also test the old model against its replacement, repair prompts that regress, and open the upgrade pull request for you.
35
+
36
+ [![PyPI](https://img.shields.io/pypi/v/modelbump)](https://pypi.org/project/modelbump/)
37
+ [![CI](https://github.com/imhammad/modelbump/actions/workflows/ci.yml/badge.svg)](https://github.com/imhammad/modelbump/actions/workflows/ci.yml)
38
+ [![Python](https://img.shields.io/badge/python-3.12%20%7C%203.13-blue)](https://www.python.org/)
39
+ [![License](https://img.shields.io/badge/license-Apache%202.0-green)](https://github.com/imhammad/modelbump/blob/main/LICENSE)
40
+ [![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-261230)](https://github.com/astral-sh/ruff)
41
+ [![Checked with mypy](https://img.shields.io/badge/mypy-strict-2a6db2)](https://mypy-lang.org/)
42
+
43
+ > **Status:** `v0.1.0` ships the first stage, **Scan**, as a command-line tool and a GitHub Action. The other stages are still being built; see the [roadmap](#roadmap).
44
+
45
+ ## The problem
46
+
47
+ Apps built on hosted LLMs (OpenAI, Anthropic, Google, ...) depend on specific model versions, and providers retire those versions on a schedule. When a model is retired, an app either breaks outright or keeps running while quietly producing worse answers, because prompts tuned for the old model don't transfer cleanly to the new one.
48
+
49
+ A 2026 study of 22,555 migration commits across 17,703 open-source repositories found that:
50
+
51
+ - **82%** of migrations happened *after* the old model was already shut down (our own re-check on a larger dataset finds a smaller share, but still more than half),
52
+ - model identifiers were **hard-coded in 94%** of migrating apps, and
53
+ - only **4%** of migrations came with any evaluation suite.
54
+
55
+ *Source: H. L. Kim, "When the Model Retires: An Empirical Study of LLM Migration in Open-Source Applications", arXiv:2609.31288, 2026.*
56
+
57
+ ## Install and scan
58
+
59
+ Requires Python 3.12 or newer.
60
+
61
+ ```bash
62
+ pip install modelbump
63
+ modelbump scan .
64
+ ```
65
+
66
+ Or run it once without installing, with [uv](https://docs.astral.sh/uv/):
67
+
68
+ ```bash
69
+ uvx modelbump scan .
70
+ ```
71
+
72
+ Each line of the report gives the file, line and column, the model ID, its status (`OK`, `RETIRING_SOON`, `DEPRECATED`, `RETIRED` or `UNKNOWN`), the shutdown date with the suggested replacement, and where the ID sits (a call argument, an assignment, a config value, a comment, ...).
73
+
74
+ Useful options:
75
+
76
+ | Option | What it does |
77
+ |--------|--------------|
78
+ | `--fail-within 30` | Exit with code 1 if a model is retired or shuts down within 30 days (for CI) |
79
+ | `--skip-comments` | Leave out IDs that only describe a model: comments, docstrings, sentences, price tables |
80
+ | `--skip-tests` | Leave out test files and test folders |
81
+ | `--exclude PATTERN` | Skip matching paths, e.g. `--exclude '*.ipynb'` (repeat for more) |
82
+ | `--format json` / `--format sarif` | Machine-readable reports; SARIF shows up in GitHub code scanning |
83
+
84
+ Run `modelbump scan --help` for the rest.
85
+
86
+ ## GitHub Action
87
+
88
+ ```yaml
89
+ name: ModelBump
90
+ on:
91
+ pull_request:
92
+ schedule:
93
+ - cron: "0 6 * * 1" # every Monday, to catch new retirement notices
94
+
95
+ permissions:
96
+ contents: read
97
+ security-events: write # to upload findings to code scanning
98
+
99
+ jobs:
100
+ scan:
101
+ runs-on: ubuntu-latest
102
+ steps:
103
+ - uses: actions/checkout@v7
104
+ - uses: imhammad/modelbump@v0.1.0
105
+ with:
106
+ fail-within: "30"
107
+ skip-comments: "true"
108
+ ```
109
+
110
+ All inputs are listed in the [scanner documentation](https://imhammad.github.io/modelbump/architecture/scanner/).
111
+
112
+ ## How well the scanner works
113
+
114
+ We ran the scanner on 100 real projects, each at the commit just before it moved off a retired model, and labelled a sample of 250 findings by hand ([evaluation details](https://imhammad.github.io/modelbump/research/scanner-eval/)):
115
+
116
+ | Setting | Finds the old model's lines (recall) | Findings that are real dependencies (precision) |
117
+ |---------|------|------|
118
+ | Default | 97.7% | 47.9% |
119
+ | `--skip-comments --skip-tests` | 82.0% | 75.2% |
120
+
121
+ Replayed on those 100 projects, the scanner flagged 96 before they migrated. The default is tuned not to miss anything; the two flags trade some misses for a much quieter report.
122
+
123
+ ## The plan
124
+
125
+ | Stage | What it does | Status |
126
+ |-------|--------------|--------|
127
+ | **Scan** | Static analysis finds every model ID in your code and config, checks it against a registry of provider retirement dates, and fails CI *before* the shutdown date. | Available (`v0.1.0`) |
128
+ | **Test** | Builds an app-specific regression suite from your prompts, tests, and (optionally) logs. | Planned |
129
+ | **Compare** | Runs old vs. new model with sequential statistical tests, separating real regressions from normal LLM randomness, within a cost budget. | Planned |
130
+ | **Repair** | Searches for prompt edits that fix regressions without breaking anything that already worked. | Planned |
131
+ | **Bump** | Opens a ready-to-review PR with the new model, repaired prompts, the regression suite, and an evidence report. | Planned |
132
+
133
+ ## Development
134
+
135
+ Requires [uv](https://docs.astral.sh/uv/).
136
+
137
+ ```bash
138
+ git clone https://github.com/imhammad/modelbump.git
139
+ cd modelbump
140
+ uv sync
141
+ uv run modelbump --version
142
+ uv run pytest
143
+ ```
144
+
145
+ ## Roadmap
146
+
147
+ - [x] **Phase 0:** Foundations: packaging, CI, pre-commit, branch protection
148
+ - [x] **Phase 1:** Migration dataset + model retirement registry
149
+ - [x] **Phase 2:** Scanner + GitHub Action (`v0.1.0`)
150
+ - [ ] **Phase 3:** Model runner with caching and cost budgets
151
+ - [ ] **Phase 4:** Statistical comparison engine
152
+ - [ ] **Phase 5:** Regression suite synthesis + LLM-judge calibration
153
+ - [ ] **Phase 6:** Prompt repair
154
+ - [ ] **Phase 7:** End-to-end `modelbump bump` + `v1.0.0`
155
+
156
+ ## Research
157
+
158
+ ModelBump is also a research project: an empirical study of how open-source LLM apps migrate off retired models (paper in preparation), and later a paper on the tool itself. Research notes, protocols and results are in the [research section of the docs](https://imhammad.github.io/modelbump/research/).
159
+
160
+ ## License
161
+
162
+ [Apache License 2.0](https://github.com/imhammad/modelbump/blob/main/LICENSE)
@@ -0,0 +1,131 @@
1
+ # ModelBump
2
+
3
+ **Dependabot for LLM models.** ModelBump finds the AI models your code depends on and warns you before a provider retires them. Later versions will also test the old model against its replacement, repair prompts that regress, and open the upgrade pull request for you.
4
+
5
+ [![PyPI](https://img.shields.io/pypi/v/modelbump)](https://pypi.org/project/modelbump/)
6
+ [![CI](https://github.com/imhammad/modelbump/actions/workflows/ci.yml/badge.svg)](https://github.com/imhammad/modelbump/actions/workflows/ci.yml)
7
+ [![Python](https://img.shields.io/badge/python-3.12%20%7C%203.13-blue)](https://www.python.org/)
8
+ [![License](https://img.shields.io/badge/license-Apache%202.0-green)](https://github.com/imhammad/modelbump/blob/main/LICENSE)
9
+ [![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-261230)](https://github.com/astral-sh/ruff)
10
+ [![Checked with mypy](https://img.shields.io/badge/mypy-strict-2a6db2)](https://mypy-lang.org/)
11
+
12
+ > **Status:** `v0.1.0` ships the first stage, **Scan**, as a command-line tool and a GitHub Action. The other stages are still being built; see the [roadmap](#roadmap).
13
+
14
+ ## The problem
15
+
16
+ Apps built on hosted LLMs (OpenAI, Anthropic, Google, ...) depend on specific model versions, and providers retire those versions on a schedule. When a model is retired, an app either breaks outright or keeps running while quietly producing worse answers, because prompts tuned for the old model don't transfer cleanly to the new one.
17
+
18
+ A 2026 study of 22,555 migration commits across 17,703 open-source repositories found that:
19
+
20
+ - **82%** of migrations happened *after* the old model was already shut down (our own re-check on a larger dataset finds a smaller share, but still more than half),
21
+ - model identifiers were **hard-coded in 94%** of migrating apps, and
22
+ - only **4%** of migrations came with any evaluation suite.
23
+
24
+ *Source: H. L. Kim, "When the Model Retires: An Empirical Study of LLM Migration in Open-Source Applications", arXiv:2609.31288, 2026.*
25
+
26
+ ## Install and scan
27
+
28
+ Requires Python 3.12 or newer.
29
+
30
+ ```bash
31
+ pip install modelbump
32
+ modelbump scan .
33
+ ```
34
+
35
+ Or run it once without installing, with [uv](https://docs.astral.sh/uv/):
36
+
37
+ ```bash
38
+ uvx modelbump scan .
39
+ ```
40
+
41
+ Each line of the report gives the file, line and column, the model ID, its status (`OK`, `RETIRING_SOON`, `DEPRECATED`, `RETIRED` or `UNKNOWN`), the shutdown date with the suggested replacement, and where the ID sits (a call argument, an assignment, a config value, a comment, ...).
42
+
43
+ Useful options:
44
+
45
+ | Option | What it does |
46
+ |--------|--------------|
47
+ | `--fail-within 30` | Exit with code 1 if a model is retired or shuts down within 30 days (for CI) |
48
+ | `--skip-comments` | Leave out IDs that only describe a model: comments, docstrings, sentences, price tables |
49
+ | `--skip-tests` | Leave out test files and test folders |
50
+ | `--exclude PATTERN` | Skip matching paths, e.g. `--exclude '*.ipynb'` (repeat for more) |
51
+ | `--format json` / `--format sarif` | Machine-readable reports; SARIF shows up in GitHub code scanning |
52
+
53
+ Run `modelbump scan --help` for the rest.
54
+
55
+ ## GitHub Action
56
+
57
+ ```yaml
58
+ name: ModelBump
59
+ on:
60
+ pull_request:
61
+ schedule:
62
+ - cron: "0 6 * * 1" # every Monday, to catch new retirement notices
63
+
64
+ permissions:
65
+ contents: read
66
+ security-events: write # to upload findings to code scanning
67
+
68
+ jobs:
69
+ scan:
70
+ runs-on: ubuntu-latest
71
+ steps:
72
+ - uses: actions/checkout@v7
73
+ - uses: imhammad/modelbump@v0.1.0
74
+ with:
75
+ fail-within: "30"
76
+ skip-comments: "true"
77
+ ```
78
+
79
+ All inputs are listed in the [scanner documentation](https://imhammad.github.io/modelbump/architecture/scanner/).
80
+
81
+ ## How well the scanner works
82
+
83
+ We ran the scanner on 100 real projects, each at the commit just before it moved off a retired model, and labelled a sample of 250 findings by hand ([evaluation details](https://imhammad.github.io/modelbump/research/scanner-eval/)):
84
+
85
+ | Setting | Finds the old model's lines (recall) | Findings that are real dependencies (precision) |
86
+ |---------|------|------|
87
+ | Default | 97.7% | 47.9% |
88
+ | `--skip-comments --skip-tests` | 82.0% | 75.2% |
89
+
90
+ Replayed on those 100 projects, the scanner flagged 96 before they migrated. The default is tuned not to miss anything; the two flags trade some misses for a much quieter report.
91
+
92
+ ## The plan
93
+
94
+ | Stage | What it does | Status |
95
+ |-------|--------------|--------|
96
+ | **Scan** | Static analysis finds every model ID in your code and config, checks it against a registry of provider retirement dates, and fails CI *before* the shutdown date. | Available (`v0.1.0`) |
97
+ | **Test** | Builds an app-specific regression suite from your prompts, tests, and (optionally) logs. | Planned |
98
+ | **Compare** | Runs old vs. new model with sequential statistical tests, separating real regressions from normal LLM randomness, within a cost budget. | Planned |
99
+ | **Repair** | Searches for prompt edits that fix regressions without breaking anything that already worked. | Planned |
100
+ | **Bump** | Opens a ready-to-review PR with the new model, repaired prompts, the regression suite, and an evidence report. | Planned |
101
+
102
+ ## Development
103
+
104
+ Requires [uv](https://docs.astral.sh/uv/).
105
+
106
+ ```bash
107
+ git clone https://github.com/imhammad/modelbump.git
108
+ cd modelbump
109
+ uv sync
110
+ uv run modelbump --version
111
+ uv run pytest
112
+ ```
113
+
114
+ ## Roadmap
115
+
116
+ - [x] **Phase 0:** Foundations: packaging, CI, pre-commit, branch protection
117
+ - [x] **Phase 1:** Migration dataset + model retirement registry
118
+ - [x] **Phase 2:** Scanner + GitHub Action (`v0.1.0`)
119
+ - [ ] **Phase 3:** Model runner with caching and cost budgets
120
+ - [ ] **Phase 4:** Statistical comparison engine
121
+ - [ ] **Phase 5:** Regression suite synthesis + LLM-judge calibration
122
+ - [ ] **Phase 6:** Prompt repair
123
+ - [ ] **Phase 7:** End-to-end `modelbump bump` + `v1.0.0`
124
+
125
+ ## Research
126
+
127
+ ModelBump is also a research project: an empirical study of how open-source LLM apps migrate off retired models (paper in preparation), and later a paper on the tool itself. Research notes, protocols and results are in the [research section of the docs](https://imhammad.github.io/modelbump/research/).
128
+
129
+ ## License
130
+
131
+ [Apache License 2.0](https://github.com/imhammad/modelbump/blob/main/LICENSE)
@@ -0,0 +1,107 @@
1
+ [project]
2
+ name = "modelbump"
3
+ version = "0.1.0"
4
+ description = "Find the LLM model IDs in your code and config, and warn before providers retire them."
5
+ readme = "README.md"
6
+ license = "Apache-2.0"
7
+ license-files = ["LICENSE"]
8
+ requires-python = ">=3.12"
9
+ keywords = [
10
+ "llm",
11
+ "model deprecation",
12
+ "model retirement",
13
+ "static analysis",
14
+ "github action",
15
+ "openai",
16
+ "anthropic",
17
+ "gemini",
18
+ ]
19
+ classifiers = [
20
+ "Development Status :: 3 - Alpha",
21
+ "Environment :: Console",
22
+ "Intended Audience :: Developers",
23
+ "Operating System :: OS Independent",
24
+ "Programming Language :: Python :: 3",
25
+ "Programming Language :: Python :: 3.12",
26
+ "Programming Language :: Python :: 3.13",
27
+ "Topic :: Software Development :: Quality Assurance",
28
+ "Typing :: Typed",
29
+ ]
30
+ dependencies = [
31
+ "pydantic>=2.13",
32
+ "pyyaml>=6.0.3",
33
+ "tree-sitter>=0.26",
34
+ "tree-sitter-python>=0.25",
35
+ "tree-sitter-typescript>=0.23.2",
36
+ "typer>=0.27.3",
37
+ ]
38
+
39
+ [[project.authors]]
40
+ name = "Hammad Hassan"
41
+
42
+ [project.urls]
43
+ Homepage = "https://github.com/imhammad/modelbump"
44
+ Documentation = "https://imhammad.github.io/modelbump/"
45
+ Repository = "https://github.com/imhammad/modelbump"
46
+ Issues = "https://github.com/imhammad/modelbump/issues"
47
+ Changelog = "https://github.com/imhammad/modelbump/blob/main/CHANGELOG.md"
48
+
49
+ [project.scripts]
50
+ modelbump = "modelbump.cli:app"
51
+
52
+ [build-system]
53
+ requires = ["uv_build>=0.12.23,<0.13.0"]
54
+ build-backend = "uv_build"
55
+
56
+ [dependency-groups]
57
+ dev = [
58
+ "mkdocs>=1.6,<2",
59
+ "mkdocs-material>=9.7.7",
60
+ "mypy>=2.4.0",
61
+ "pre-commit>=4.6.2",
62
+ "pytest>=9.1.1",
63
+ "pytest-cov>=7.1.0",
64
+ "ruff>=0.16.10",
65
+ "types-pyyaml>=6.0.12.20260906",
66
+ ]
67
+ research = [
68
+ "httpx>=0.28.1",
69
+ "matplotlib>=3.11.2",
70
+ ]
71
+
72
+ [tool.uv]
73
+ default-groups = [
74
+ "dev",
75
+ "research",
76
+ ]
77
+
78
+ [tool.ruff]
79
+ line-length = 100
80
+ target-version = "py312"
81
+
82
+ [tool.ruff.lint]
83
+ select = [
84
+ "E",
85
+ "F",
86
+ "W",
87
+ "I",
88
+ "B",
89
+ "UP",
90
+ "SIM",
91
+ "RUF",
92
+ ]
93
+
94
+ [tool.mypy]
95
+ strict = true
96
+ python_version = "3.12"
97
+ files = [
98
+ "src",
99
+ "tests",
100
+ "research",
101
+ ]
102
+ exclude = ["^research/data/"]
103
+
104
+ [tool.pytest.ini_options]
105
+ testpaths = ["tests"]
106
+ pythonpath = ["."]
107
+ addopts = "-ra --strict-markers --cov=modelbump --cov=research --cov-report=term-missing"