obelize 0.1.0__tar.gz

obelize-0.1.0/.gitignore

@@ -0,0 +1,36 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.eggs/
+
+# Environments
+.venv/
+venv/
+env/
+
+# Tooling caches
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.tox/
+.nox/
+.coverage
+coverage.xml
+htmlcov/
+
+# Obelize runtime artifacts
+.obelize/
+
+# Benchmark checkouts (bench/results/ is committed)
+bench/work/
+
+# Secrets
+.env
+.env.*
+!.env.example
+
+# OS
+.DS_Store

obelize-0.1.0/CHANGELOG.md

@@ -0,0 +1,145 @@
+# Changelog
+
+Notable changes per release, in [Keep a Changelog 1.1.0](https://keepachangelog.com/en/1.1.0/)
+format. Versions are `0.MINOR.PATCH`.
+
+## Stability
+
+Every format obelize reads or writes is unstable through 0.x: the CLI surface, the exit codes,
+`.obelize.yml`, migration packs, the run folder and its JSON Schemas. None of them carries a
+format version, so a 0.x release can change any of them, and this file lists each format change
+in the release that makes it.
+
+## [Unreleased]
+
+## [0.1.0] - 2026-10-06
+
+### Benchmark
+
+I measured this release on public repositories, against answer keys I wrote by hand. The sample
+leans towards small single-purpose applications. The
+[results page](https://github.com/hakanbogan/obelize/blob/v0.1.0/docs/BENCHMARK_RESULTS.md) has
+the method and every case.
+
+- Scan precision is 100.0% and recall is 98.4%, over 64 usages I labelled in five repositories
+  before the scanner ran on them. The scan reported 63 of the 64, and all 63 were right.
+- obelize migrated 25 of 277 usages (9.0%) in 20 repositories and left the other 252 for a
+  person. The most common reason, for 98 of them, is that something else in the same file or
+  repository was not migrated, since obelize writes a file only when it can migrate all of it.
+  Another 129 were withheld for a stated reason, most often a module with more than one
+  `configure()` call (19 usages), the old SDK imported inside a function (18) or the module alias
+  reassigned (17). The last 25 the scan never reported, mostly code reached through a function's
+  return value, a star import in another file or a container.
+- obelize wrote nothing in 14 of the 20 repositories, migrated part of five and finished one.
+  None got a wrong edit. The scan did report three usages that my answer keys do not list, and
+  none of the three was edited.
+- None of the 20 was migrated and verified by its own tests. Of the 20, 16 have no test command,
+  including the one obelize finished, and each of the four that do holds a usage no rule writes.
+- On 13 of those repositories (174 usages) I also ran a general-purpose coding agent, given
+  Google's migration guide and one fixed prompt. It migrated 154 usages (88.5%) against
+  obelize's 17 (9.8%), and one of its migrations was verified by the repository's tests where
+  none of obelize's was. It made a wrong edit in two of the 13 repositories, both real defects,
+  and obelize in none. The agent does far more of the work, so I do not claim obelize is more
+  accurate. The comparison shows that obelize made no wrong edit and names a reason for each
+  usage it withholds. It is one agent, one day and one snapshot of the guide, on the split
+  obelize's rules were tuned against. The agent's side dates from 2026-09-22 and was not rerun
+  for 0.1.0, so its guide and model may have moved since.
+
+### Unsupported patterns
+
+The bundled pack declares 20 limitations, among them rewrites never checked against a live API
+call. [docs/KNOWN_ISSUES.md](https://github.com/hakanbogan/obelize/blob/v0.1.0/docs/KNOWN_ISSUES.md)
+lists what else I know about and have chosen not to fix yet. The main gaps:
+
+- Every tool declaration is reported and never rewritten, because automatic function calling is
+  on by default in `google-genai`.
+- Model names are kept as written. Google has retired the `gemini-1.5` models, so change such a
+  name yourself.
+- Notebooks (`.ipynb`) that use the old SDK are found and not migrated, and the old dependency
+  line stays while one does.
+- Code that reaches the SDK through a function's return value, a star import in another file or
+  a container is not found.
+- obelize leaves a whole file as it was when the file has a `configure()` call in another module
+  or more than one in the module, the old SDK imported inside a function, the module alias
+  reassigned, or a model object passed around or read from another module.
+- `mock.patch` targets, dynamic imports and surfaces with no rule, such as `protos`, `caching`
+  and tuning, are reported and never rewritten. A `sys.modules` stub of the old module can be
+  left in place without a report.
+- Four safety gaps stay open, described in
+  [docs/THREAT_MODEL.md](https://github.com/hakanbogan/obelize/blob/v0.1.0/docs/THREAT_MODEL.md):
+  a git command obelize runs can start a program that the repository's git configuration names
+  (on Windows it can also load a DLL from the repository that git finds nowhere else),
+  running `obelize verify` again or `obelize undo` twice can overwrite the earlier record,
+  redaction misses common credential shapes, and Ctrl-C can leave a verification command's
+  processes running. On Windows that last gap is a process a broker such as WMI or Task
+  Scheduler starts, and redaction also misses a secret written as UTF-16 or, with non-ASCII
+  characters, in an older code page. Run obelize in a repository that is committed or backed up.
+
+### Added
+
+- obelize runs on Windows. It writes files, and opens run-folder files, relative to their parent
+  directory and refuses a symbolic link or a junction as it does elsewhere, and a verification
+  command and everything it starts run in a job object that the deadline ends. CI runs the suite on Windows for Python 3.12
+  and 3.14. A real console, a OneDrive folder and a path longer than 260 characters are untried.
+- `.obelize/` carries its own `.gitignore` holding `*`, so `git add -A` never picks up a run
+  folder.
+- A dry run of `obelize fix` prints up to 200 lines of the diff after its file list, with
+  secrets redacted and control characters escaped, then the path of the whole `patch.diff`.
+  `--json` output is unchanged.
+- An apply ends with a `Next:` line naming the command to run after its exit code, and a
+  run with nothing to write names the reason that held back the most findings. A
+  `--verify` program that never started is named, with the interpreter form to use instead.
+  `--json` output is unchanged.
+- `python -m obelize` runs the CLI where the `obelize` script is not on `PATH`.
+- `obelize scan` explains its table's columns in one line under it.
+
+### Changed
+
+- `obelize pack validate --help` links the pack format on GitHub instead of a `docs/` path,
+  which an installed copy does not have. A defect in a bundled pack links the issue tracker,
+  a refusal over a dirty tree names `--allow-dirty`, and `obelize --help` names the migration
+  it supports.
+- `obelize fix` uses the bundled Gemini pack when `--pack` is not given, as `obelize scan`
+  does.
+- `obelize fix --help` names the two `--model` providers, `none` and `openai_compat`.
+- Help, terminal output, `REPORT.md` and error messages use plainer words and cite no design
+  records. A refused `--verify` names the flag without pydantic's "Value error," prefix, and an
+  apply refused over a file git does not track says to commit it, since `git stash` would
+  leave it in place. `~/.config/obelize/config.yml` lists every problem under its key, and a
+  misspelt key is matched against the keys that file accepts.
+- The run folder's path is printed under `--repo` as typed, so it opens from the directory
+  the command ran in. A second `obelize undo` of a run marks each file that holds its
+  original again "(already the original)"; it still exits `4`. Terminal output and
+  `--help` carry no Markdown backticks.
+
+### Fixed
+
+- An Intel Mac installs libcst 1.8, which has a wheel for that platform, so installing
+  obelize there needs no Rust compiler. libcst 1.9 has no Intel macOS wheel.
+- `--json` writes its document as UTF-8 bytes whatever the terminal's encoding, so stdout
+  holds the same bytes as `findings.json` or `plan.json`.
+- A file or directory whose name holds a backslash or is not valid UTF-8 no longer stops
+  `obelize scan` before it writes any evidence. `run.json` lists it as `unusable_name` with no path, and the
+  detail quotes the name.
+- A run blocked by a declared Python floor below 3.10 says which file to change and to what,
+  and `obelize fix` prints that reason too, where it only counted rows it did not write. An
+  empty plan prints "No change planned.", and the verification line counts the commands a
+  failing baseline ran.
+- `obelize fix --apply` refuses to rewrite a file git does not track unless `--allow-dirty`
+  is given, since `git diff` could not show that change. Other untracked files, the run
+  folder among them, still do not count.
+- `obelize verify --run` records its result after an apply that ran no verification command.
+- A `Next:` line quotes the repository and the suggested tests the way the shells of the
+  system it runs on read them, and a path the summary names inside the run folder uses one
+  separator throughout.
+- When an apply's write is refused after the tests before it ran, the verification line
+  counts the commands that ran, and `run.json` keeps their results as the baseline and
+  their time in `timings.verify_ms`.
+- The note `obelize verify` adds to `REPORT.md` says whether tests ran before the change,
+  and where they did, points at the report's Baseline section.
+- The hint about a test command from obelize's own environment says whether it failed or
+  timed out.
+- A `--model` refused over the model block names the configuration file obelize read,
+  wherever `XDG_CONFIG_HOME` puts it.
+- A `--verify` command that needs a shell or has an unclosed quote exits `2` with the reason
+  instead of a traceback, and so does an unusable allowlist entry in `obelize verify`.

obelize-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

obelize-0.1.0/NOTICE

@@ -0,0 +1,10 @@
+Obelize
+Copyright 2026 Hakan Bogan
+
+This product includes software developed by Hakan Bogan.
+
+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