python-devkit 0.1.0__tar.gz

python_devkit-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - name: Lint
+        run: uv run ruff check .
+
+      - name: Format
+        run: uv run ruff format --check .
+
+      - name: Type check
+        run: uv run basedpyright

python_devkit-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,25 @@
+name: Release
+
+on:
+  workflow_run:
+    workflows: [CI]
+    types: [completed]
+    branches: [main]
+
+jobs:
+  publish:
+    if: github.event.workflow_run.conclusion == 'success' && github.event.workflow_run.event == 'push' && github.event.workflow_run.head_branch == 'main'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@v5
+
+      # Workaround: fetch-tags is broken with shallow clones
+      - run: git fetch --tags origin
+
+      - uses: astral-sh/setup-uv@v7
+
+      - name: Publish
+        run: uvx --from release-devkit==0.1.0 publish-packages --config publish-config.json

python_devkit-0.1.0/.gitignore

@@ -0,0 +1,12 @@
+**/__pycache__
+**/*.pyc
+**/*.pyo
+**/*.pyd
+**/.venv/
+**/*.egg-info
+**/build/
+dist/
+.pytest_cache
+.ruff_cache
+.env
+bookmark.md

python_devkit-0.1.0/.python-version

@@ -0,0 +1 @@
+3.13

python_devkit-0.1.0/AGENTS.md

@@ -0,0 +1,31 @@
+# python-devkit
+
+## What this is
+
+The python repo-lifecycle devkit — the `-devkit` family's home for tooling every Python repo needs at dev/CI time: the GitHub Actions step wrapper, CI runner provisioning, and (per the tooling-consolidation program) the generalized `lock-python`, the preflight check runner, the canonical ruff configuration with its sync verb and drift gate, and the reusable python check workflow. The org's one dedicated Python-domain devkit: runtime libraries stay standalone (`logger-conf`, `bashrun`), and registry-specific machinery lives in `release-devkit`.
+
+The package is `python_devkit` (src-layout under `src/python_devkit/`); all dependencies resolve from PyPI (`bashrun`, `pydantic`, `pydantic-settings`; git-source pins only in scratch branches testing unreleased changes). Born 2026-09-21 from unity-devkit's `ci_step` + runner-setup cohort moving out (release-devkit's unity dependency dropped to zero in the same change).
+
+## Release flow
+
+Publishing rides `release.yml`, triggered by a successful CI run on a `main` push: the machinery — release-devkit, invoked uvx-isolated, never a project dependency — computes the plan from the tag ledger and path-diff, patches the version ephemerally, and publishes to PyPI under OIDC trusted publishing (publisher bound to `release.yml`, no environment). The committed `pyproject.toml` version is permanently the `0.0.0.dev0` sentinel; the `python-devkit-v*` tags are the version ledger (first release `0.1.0`, patch-auto thereafter). API-breaking changes ship with a manually bumped version — patch-auto assumes additive changes.
+
+## Shape
+
+| Module | Role |
+|---|---|
+| `ci_step.py` | `ci_step(label)` context manager — wraps a step in `::group::`/`::endgroup::`, times it, and appends a duration row to `$GITHUB_STEP_SUMMARY` (failure-marked on exception). |
+| `setup.py` | CI runner provisioning: `configure_git` (re-sets checkout's `safe.directory` in the real HOME), `free_disk_space` (strips preinstalled toolchains; container/bare-linux/Windows paths), `install_dotnet` (via the vendored `third-party/dotnet-install.sh`, PATH + `$GITHUB_PATH` wiring), `install_node` (nodejs.org tarball, npm registry override). |
+| `setup_oras.py` | `install_oras` — installs the ORAS CLI (zstd dependency included) and logs into ghcr.io with the job token. |
+| `third-party/` | Vendored `dotnet-install.sh` (curl-downloading it inside CI containers is unreliable — the same reason `actions/setup-dotnet` bundles it); resolved `__file__`-relative, so it works in editable installs, wheels, and git checkouts alike. |
+
+## Constraints
+
+- **The module surface is cross-repo Python API.** `ci_step`, the `setup` functions, and `install_oras` are imported by release-devkit, unity-devkit, and consumer repos' CI commands — the import paths and signatures are contract, not internals. This package must stay dependency-light: anything with a heavyweight or domain-specific dep graph (Unity, docker, registry feeds) belongs in its sibling devkit, not here.
+- **No Unity- or registry-specific code.** Unity build tooling lives in `unity-devkit`; compose-stack lifecycle in `docker-devkit`; publication machinery in `release-devkit`. When a module grows a domain, it moves out — this repo is the domainless floor.
+- **CI tooling prints to stdout by design** — step output is the operator interface; the `print` ignore rides the org-wide PLE-336 deferral like the sibling devkits and will never convert to structured logging here.
+
+## See also
+
+- `README.md` — human-facing setup and consumer install snippet.
+- [`bashrun`](https://github.com/outernet-foundation/bashrun) — the shell-exec helpers the provisioning functions use.

python_devkit-0.1.0/CLAUDE.md

@@ -0,0 +1 @@
+@AGENTS.md

python_devkit-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.

python_devkit-0.1.0/NOTICE

@@ -0,0 +1 @@
+Copyright 2026 Tyler Hatch

python_devkit-0.1.0/PKG-INFO

@@ -0,0 +1,10 @@
+Metadata-Version: 2.5
+Name: python-devkit
+Version: 0.1.0
+Summary: Python repo-lifecycle tooling: CI step wrapper, runner provisioning, workspace locking, preflight checks
+License-File: LICENSE
+License-File: NOTICE
+Requires-Python: >=3.13
+Requires-Dist: bashrun>=0.1.0
+Requires-Dist: pydantic-settings>=2.9.1
+Requires-Dist: pydantic>=2.11.7

python_devkit-0.1.0/README.md

@@ -0,0 +1,34 @@
+# python-devkit
+
+Python repo-lifecycle tooling shared across outernet-foundation repos: the CI step wrapper (`ci_step`), CI runner provisioning (`configure_git`, `free_disk_space`, `install_dotnet`, `install_node`, `install_oras`), and — as the program progresses — workspace locking, the preflight check runner, and the canonical ruff configuration. Sibling of `unity-devkit`, `docker-devkit`, and `release-devkit` in the `-devkit` family; `bashrun` and `logger-conf` stay standalone.
+
+## Setup
+
+Requires Python 3.13+ and [uv](https://docs.astral.sh/uv/).
+
+```bash
+uv sync
+```
+
+## Consuming from another repo
+
+```toml
+[project]
+dependencies = ["python-devkit>=0.1.0"]
+```
+
+```python
+from python_devkit.ci_step import ci_step
+from python_devkit.setup import configure_git, free_disk_space, install_dotnet, install_node
+from python_devkit.setup_oras import install_oras
+```
+
+To test an unreleased change, pin the repo at a git ref in a scratch branch instead (`python-devkit = { git = "…", rev = "<sha>" }` under `[tool.uv.sources]`) and drop the pin when the release lands.
+
+## Development
+
+```bash
+uv run ruff check .
+uv run ruff format --check .
+uv run basedpyright
+```

python_devkit-0.1.0/publish-config.json

@@ -0,0 +1,11 @@
+{
+  "packages": [
+    {
+      "name": "python-devkit",
+      "path": ".",
+      "feeds": { "pypi": "python-devkit" }
+    }
+  ],
+  "ci_workflow": "ci.yml",
+  "mirror_prefix": "ghcr.io/outernet-foundation/mirror"
+}

python_devkit-0.1.0/pyproject.toml

@@ -0,0 +1,29 @@
+[project]
+name = "python-devkit"
+version = "0.1.0"
+description = "Python repo-lifecycle tooling: CI step wrapper, runner provisioning, workspace locking, preflight checks"
+requires-python = ">=3.13"
+dependencies = [
+    "bashrun>=0.1.0",
+    "pydantic>=2.11.7",
+    "pydantic-settings>=2.9.1",
+]
+
+[dependency-groups]
+dev = ["basedpyright>=1.39.10", "ruff>=0.14.11"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/python_devkit"]
+include = ["src/python_devkit/py.typed", "src/python_devkit/third-party/**"]
+
+[tool.uv.sources]
+
+[tool.basedpyright]
+venvPath = "."
+venv = ".venv"
+typeCheckingMode = "strict"
+include = ["src"]

python_devkit-0.1.0/ruff.toml

@@ -0,0 +1,95 @@
+target-version = "py313"
+line-length = 120
+preview = true
+
+[lint]
+select = ["ALL"]
+ignore = [
+    # ── Permanent ─────────────────────────────────────────────────────────
+    # Type annotations — basedpyright strict mode handles this
+    "ANN",
+    # No docstrings, no copyright headers
+    "D",
+    "DOC",
+    "CPY",
+    # TODO/FIXME comment formatting
+    "TD",
+    "FIX",
+    # Exception message ergonomics — literal-indirection and custom-class churn without benefit
+    "raw-string-in-exception",
+    "f-string-in-exception",
+    "raise-vanilla-args",
+    # Class attribute names never conflict with builtins via self.x
+    "builtin-attribute-shadowing",
+    # Function-size counters — C901 already covers structural complexity
+    "too-many-return-statements",
+    "too-many-branches",
+    "too-many-arguments",
+    "too-many-locals",
+    "too-many-statements",
+    "too-many-positional-arguments",
+    # Typer's Option/Argument in argument defaults is typer's standard API pattern
+    "function-call-in-default-argument",
+    # Boolean parameters read fine as keyword-only flags here
+    "boolean-type-hint-positional-argument",
+    "boolean-default-value-positional-argument",
+    "boolean-positional-value-in-call",
+    # Relative imports are the intra-package convention
+    "relative-imports",
+    # Formatter-owned; enforced by `ruff format`
+    "missing-trailing-comma",
+    "unsorted-imports",
+    # Magic values in comparisons are readable in this CLI
+    "magic-value-comparison",
+    # The formatter owns wrapping; long string literals and URLs stay on one line
+    "line-too-long",
+    # src-layout tests need no __init__.py
+    "implicit-namespace-package",
+    # Runtime-used typing imports stay at module level
+    "typing-only-first-party-import",
+    "typing-only-third-party-import",
+    "typing-only-standard-library-import",
+    # Small literal tuples read fine in membership tests
+    "literal-membership",
+
+    # ── Deferred to PLE-248 — Enforce the deferred ruff rules
+    # https://linear.app/plerionplatforms/issue/PLE-248
+    # Mirrors placeframe's root ruff.toml transitional Ticket-N blocks; lifting
+    # a rule here should happen alongside lifting it from placeframe's ruff.toml.
+    "runtime-cast-value",    # move import into TYPE_CHECKING block (quoted annotation) — Ticket 1
+    "redundant-open-modes",    # unnecessary open mode parameters — Ticket 1
+    "read-whole-file",  # read-text can replace open+read — Ticket 2
+    "write-whole-file",  # write-text can replace open+write — Ticket 2
+    "repeated-append",  # use list.extend instead of repeated append — Ticket 2
+    "unspecified-encoding",  # open/read_text without explicit encoding — Ticket 2
+    "os-chmod",   # os.chmod → Path.chmod — Ticket 2
+    "os-path-isdir",   # os.path.isdir → Path.is_dir — Ticket 2
+    "os-path-join",   # os.path.join → Path / — Ticket 2
+    "builtin-open",   # open() → Path.open() — Ticket 2
+    "unnecessary-assign",   # unnecessary assignment before return — Ticket 2
+    "superfluous-else-return",   # unnecessary else after return — Ticket 2
+    "collection-literal-concatenation",   # consider spread operator instead of concatenation — Ticket 2
+    "collapsible-if",   # collapsible if statements — Ticket 2
+    "open-file-with-context-handler",   # use context manager for opening files — Ticket 2
+    "multiple-with-statements",   # use single with statement for multiple context managers — Ticket 2
+    "raise-without-from-inside-except",     # raise ... from inside except — Ticket 8
+    "blind-except",   # blind except Exception — Ticket 8
+    "try-consider-else",   # try/except/return — move return into else — Ticket 8
+    "complex-structure",     # function too complex — Ticket 9
+    "import-outside-top-level",  # import not at top level — Ticket 9
+    "global-statement",  # global statement — Ticket 9
+    "redefined-loop-name",  # loop variable overwritten — Ticket 9
+    "path-constructor-current-directory",   # do not pass "." explicitly to Path — Ticket 2
+    "bad-file-permissions",     # bad-file-permissions (0o755 on executable) — Ticket 9
+    "hardcoded-temp-file",     # hardcoded temp file / directory — Ticket 9
+    "suspicious-subprocess-import",     # suspicious subprocess import — Ticket 9
+    "subprocess-without-shell-equals-true",     # subprocess call with non-literal — Ticket 9
+    "start-process-with-partial-path",     # start-process-with-partial-path — Ticket 9
+
+    # ── Deferred to PLE-336 — Replace print() with structured logging
+    # https://linear.app/plerionplatforms/issue/PLE-336
+    "print",     # print found
+]
+
+[lint.flake8-builtins]
+ignorelist = ["id", "map"]

python_devkit-0.1.0/src/python_devkit/ci_step.py

@@ -0,0 +1,52 @@
+from __future__ import annotations
+
+import time
+from collections.abc import Generator
+from contextlib import contextmanager
+
+from pydantic_settings import BaseSettings
+
+
+class Settings(BaseSettings):
+    github_step_summary: str | None = None
+
+
+settings = Settings.model_validate({})
+_summary_initialized = False
+
+
+def _format_duration(seconds: float) -> str:
+    if seconds < 60:
+        return f"{seconds:.1f}s"
+    minutes = int(seconds // 60)
+    remaining = seconds % 60
+    return f"{minutes}m {remaining:.0f}s"
+
+
+def _write_summary(label: str, duration: float, *, failed: bool) -> None:
+    global _summary_initialized
+    summary_path = settings.github_step_summary
+    if not summary_path:
+        return
+    with open(summary_path, "a") as file:
+        if not _summary_initialized:
+            file.write("| Step | Duration |\n|---|---|\n")
+            _summary_initialized = True
+        status = " :x:" if failed else ""
+        file.write(f"| {label}{status} | {_format_duration(duration)} |\n")
+
+
+@contextmanager
+def ci_step(label: str) -> Generator[None]:
+    print(f"::group::{label}", flush=True)
+    start = time.monotonic()
+    failed = False
+    try:
+        yield
+    except BaseException:
+        failed = True
+        raise
+    finally:
+        duration = time.monotonic() - start
+        print("::endgroup::", flush=True)
+        _write_summary(label, duration, failed=failed)