spritegen-cli 0.1.0__tar.gz

spritegen_cli-0.1.0/.env.template

@@ -0,0 +1,14 @@
+# spritegen environment. Copy to .env and fill in.
+# The CLI reads .env from the working directory on start-up; an exported
+# variable wins over the file, so a one-off key still beats a stale one here.
+# .env is gitignored; this template is not — never put a real key here.
+
+# Required by every paid stage (anchor, motion, video, matte).
+# Get one at https://fal.ai/dashboard/keys
+FAL_KEY=
+
+# Optional. Where asset directories live. Default: assets/ under the working directory.
+#SPRITEGEN_ASSETS=
+
+# Optional. Extra hosts a download may come from, comma-separated.
+#SPRITEGEN_ALLOWED_HOSTS=

spritegen_cli-0.1.0/.gitattributes

@@ -0,0 +1,8 @@
+# The last matching line wins, so the general rule comes first and the exception after it.
+* text=auto eol=lf
+
+# Parity fixtures are hashed byte for byte. A file git converts on checkout is a
+# different file on Windows than on Linux, and the digest recorded in manifest.json then
+# only matches on the machine that captured it — which is exactly what CI caught: the
+# manifest held the Windows working-tree bytes, and the repository's own bytes failed.
+tests/parity/** -text

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

@@ -0,0 +1,119 @@
+name: CI
+
+# Every push and every pull request. The suite is a few seconds of pure Python — there
+# is no GPU here and no paid call can be made, because `tests/conftest.py` closes every
+# route out of the process.
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+  workflow_dispatch:
+
+concurrency:
+  # A second push to the same branch cancels the first. The last commit is the one whose
+  # answer anybody wants.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          persist-credentials: false
+
+      - name: Install uv
+        # Pinned to the patch, not a floating major: astral-sh/setup-uv publishes no
+        # `v10` tag, unlike actions/*, so `@v10` does not resolve at all.
+        uses: astral-sh/setup-uv@v10.0.1
+        with:
+          python-version: "3.13"
+          enable-cache: true
+
+      - name: Install
+        run: uv sync --frozen
+
+      - name: Ruff
+        run: uv run ruff check src tests
+
+  test:
+    name: ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        # All three, one Python. The risk this matrix is for is the operating system:
+        # this tool builds paths out of names that arrive from a command line and out of
+        # a state file, and `workspace.check_name` and `workspace.inside` guard cases —
+        # reserved device names, drive-relative paths, 8.3 aliases, reparse points — that
+        # exist on one of them only. It has already earned its keep: the parity fixtures
+        # turned out to be pinning the PNG encoder, and a `.env` test was reading the
+        # runner's temporary-directory layout. Both were green on Windows alone.
+        os: [ubuntu-latest, windows-latest, macos-latest]
+
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          persist-credentials: false
+
+      - name: Install uv
+        # Pinned to the patch, not a floating major: astral-sh/setup-uv publishes no
+        # `v10` tag, unlike actions/*, so `@v10` does not resolve at all.
+        uses: astral-sh/setup-uv@v10.0.1
+        with:
+          python-version: "3.13"
+          enable-cache: true
+
+      - name: Install
+        # Without the extras, deliberately. `torch` with CUDA is some two gigabytes and
+        # `rembg` brings onnxruntime, and every test that touches either one asserts the
+        # refusal a *missing* extra produces — installing them here would turn those
+        # tests into skips and lose the coverage silently. That the extras still resolve
+        # is what `uv lock --check` answers, in the job below.
+        run: uv sync --frozen
+
+      - name: Test
+        # The coverage floor lives in pyproject.toml, so it is the same number here and
+        # on anybody's machine. It sits below the real figure on purpose: `rrdb.py` and
+        # most of `upscale.py` and `matting.py` cannot run without the extras that are
+        # deliberately not installed, and pretending otherwise would mean either two
+        # gigabytes per job or tests that assert nothing.
+        run: uv run pytest -q --cov
+
+  package:
+    name: package
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          persist-credentials: false
+
+      - name: Install uv
+        # Pinned to the patch, not a floating major: astral-sh/setup-uv publishes no
+        # `v10` tag, unlike actions/*, so `@v10` does not resolve at all.
+        uses: astral-sh/setup-uv@v10.0.1
+        with:
+          python-version: "3.13"
+          enable-cache: true
+
+      - name: The lock agrees with pyproject.toml
+        # Not under UV_FROZEN. That variable turns this into a validity check and prints
+        # a warning saying so, which is the one thing this step is not for: a lock that
+        # is valid but stale against pyproject.toml is exactly the drift being looked
+        # for. `--frozen` belongs on the syncs, and only there.
+        run: uv lock --check
+
+      - name: Build
+        run: uv build
+
+      - name: The console script runs out of the built wheel, with nothing else supplied
+        # `--no-project` so it resolves the wheel rather than the checkout beside it: the
+        # thing under test is what would be installed, not what is on disk here. Nothing
+        # is added to the command, and that is the assertion — a wheel that needs a
+        # hand-passed git URL to start is a wheel nobody can install.
+        run: uv run --isolated --no-project --with dist/*.whl spritegen --version

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

@@ -0,0 +1,161 @@
+name: Release
+
+# Tag-triggered. `v0.2.0` builds the distributions, checks the tag agrees with the
+# version in pyproject.toml, smoke-tests both, and attaches them to a GitHub Release.
+#
+# ---------------------------------------------------------------------------------
+# The two things that used to block PyPI are gone: the package is `spritegen-cli`, and
+# `pixelfixer` is no longer a declared dependency — it is on no registry, and a direct
+# URL in `dependencies` or an extra makes a distribution PyPI refuses, so it became an
+# optional install that `imaging.require_pixelfixer` names. The built wheel now installs
+# from its metadata alone, which the `package` job in ci.yml asserts on every commit.
+#
+# Publishing is driven by one secret, `PUBLISH_TOKEN`, on the `pypi` environment:
+#
+#   1. On GitHub, create the `pypi` environment. Add a required reviewer there if
+#      publishing should stop for a human before it happens.
+#   2. Put a PyPI API token in it as `PUBLISH_TOKEN`, scoped to this project rather than
+#      to the whole account — a project-scoped token can only ever publish this package.
+#
+# **The secret is the switch.** Without it the job runs, says nothing was published, and
+# succeeds; the distributions are on the GitHub Release either way. There is no second
+# on/off variable to forget, or to disagree with the secret.
+#
+# A long-lived token is a credential sitting in a repository until somebody rotates it.
+# PyPI's trusted publishing avoids that — an OIDC exchange per run, nothing stored — and
+# is worth moving to. It needs `permissions: id-token: write` here and the publisher
+# registered on PyPI, and then `PUBLISH_TOKEN` can be deleted.
+# ---------------------------------------------------------------------------------
+
+on:
+  push:
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+"
+      - "v[0-9]+.[0-9]+.[0-9]+rc[0-9]+"
+      - "v[0-9]+.[0-9]+.[0-9]+[ab][0-9]+"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: build and verify
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          persist-credentials: false
+
+      - name: Install uv
+        # Pinned to the patch, not a floating major: astral-sh/setup-uv publishes no
+        # `v10` tag, unlike actions/*, so `@v10` does not resolve at all.
+        uses: astral-sh/setup-uv@v10.0.1
+        with:
+          python-version: "3.13"
+          enable-cache: false
+
+      - name: The tag agrees with the version
+        # The version lives in pyproject.toml and the tag is typed by hand, so they drift
+        # the first time somebody is in a hurry — and the failure is silent: v0.2.0 ships
+        # a distribution that calls itself 0.1.0, and the index rejects it later as a
+        # duplicate for reasons nobody can see from the tag.
+        if: startsWith(github.ref, 'refs/tags/')
+        run: |
+          tagged="${GITHUB_REF_NAME#v}"
+          declared="$(uv version --short)"
+          if [ "$tagged" != "$declared" ]; then
+            echo "tag $GITHUB_REF_NAME says $tagged; pyproject.toml says $declared" >&2
+            exit 1
+          fi
+          echo "both say $declared"
+
+      - name: The lock agrees with pyproject.toml
+        run: uv lock --check
+
+      - name: Lint and test
+        # A tag is not a promise that CI ran on that commit — it can be pushed to any
+        # commit, including one that never opened a pull request.
+        run: |
+          uv sync --frozen
+          uv run ruff check src tests
+          uv run pytest -q --cov
+
+      - name: Build
+        run: uv build
+
+      - name: Smoke test the wheel
+        # Nothing supplied but the wheel. What is being tested is that somebody who runs
+        # `pip install spritegen-cli` gets something that starts.
+        run: uv run --isolated --no-project --with dist/*.whl spritegen --version
+
+      - name: Smoke test the source distribution
+        run: uv run --isolated --no-project --with dist/*.tar.gz spritegen --version
+
+      - name: Upload the distributions
+        uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: dist/
+
+  github-release:
+    name: github release
+    needs: [build]
+    if: startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish the release with the distributions attached
+        env:
+          GH_TOKEN: ${{ github.token }}
+          REPO: ${{ github.repository }}
+        run: |
+          gh release create "$GITHUB_REF_NAME" dist/* \
+            --repo "$REPO" \
+            --title "$GITHUB_REF_NAME" \
+            --generate-notes
+
+  pypi:
+    name: pypi
+    needs: [build]
+    if: startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    # The secret lives on this environment rather than on the repository, which is what
+    # keeps it out of reach of a workflow on a fork or a branch — and it is where a
+    # required reviewer goes, if publishing should stop for a human first.
+    environment:
+      name: pypi
+    steps:
+      - name: Install uv
+        # Pinned to the patch, not a floating major: astral-sh/setup-uv publishes no
+        # `v10` tag, unlike actions/*, so `@v10` does not resolve at all.
+        uses: astral-sh/setup-uv@v10.0.1
+        with:
+          python-version: "3.13"
+          enable-cache: false
+
+      - uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish
+        # **The secret is the switch.** There is no separate on/off variable to forget or
+        # to disagree with: no `PUBLISH_TOKEN`, no publish, and the run says so instead of
+        # failing on an empty credential. Setting the secret is the act that turns this
+        # on, and unsetting it is the act that turns it off.
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.PUBLISH_TOKEN }}
+        run: |
+          if [ -z "${UV_PUBLISH_TOKEN}" ]; then
+            echo "no PUBLISH_TOKEN on the pypi environment; nothing was published." >&2
+            echo "The distributions are on the GitHub Release for this tag." >&2
+            exit 0
+          fi
+          uv publish

spritegen_cli-0.1.0/.gitignore

@@ -0,0 +1,219 @@
+# 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
+.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
+
+# 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 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
+assets/

spritegen_cli-0.1.0/PKG-INFO

@@ -0,0 +1,16 @@
+Metadata-Version: 2.5
+Name: spritegen-cli
+Version: 0.1.0
+Summary: Sprite generation CLI — a few AI-generated images into a game-ready character sheet
+Requires-Python: >=3.11
+Requires-Dist: av>=12.0
+Requires-Dist: fal-client>=0.5
+Requires-Dist: httpx>=0.27
+Requires-Dist: numpy>=1.26
+Requires-Dist: opencv-python>=5.0.0.93
+Requires-Dist: pillow>=10.0
+Requires-Dist: pydantic-settings>=2.0
+Provides-Extra: matte
+Requires-Dist: rembg>=2.0; extra == 'matte'
+Provides-Extra: upscale
+Requires-Dist: torch>=2.0; extra == 'upscale'

spritegen_cli-0.1.0/README.md

@@ -0,0 +1,105 @@
+# spritegen
+
+A sprite generation CLI: a handful of AI-generated images in, the frames of a game-ready
+character sheet out, one named stage at a time.
+
+```
+pip install spritegen-cli        # the package; the command is `spritegen`
+```
+
+Three things it can do are optional installs, because each is large and none is needed by
+the rest:
+
+```
+pip install "spritegen-cli[upscale]"   # Real-ESRGAN locally, so a paid call need not buy resolution
+pip install "spritegen-cli[matte]"     # BiRefNet locally, so cutting a background costs nothing
+pip install "pixelfixer @ git+https://github.com/Retro-Diffusion/pixel-art-fixer.git#subdirectory=python"
+                                       # the pixel-art direction, which recovers a native grid
+```
+
+`pixelfixer` is on no registry, so it cannot be an extra: a direct URL in a distribution's
+metadata is one PyPI refuses. Every command says which install it needs when it needs one.
+
+```
+spritegen new <character>
+spritegen anchor <character>     # the character, one image
+spritegen pose   <character>     # where an animation starts, when the anchor is not it
+spritegen motion <character>     # movement from a driving clip
+spritegen video  <character>     # or animate the anchor directly
+spritegen matte  <character>     # cut the background
+spritegen board  <character>     # close it into a sheet row, 166 px cells
+spritegen upscale <character>    # enlarge an artifact locally, for nothing
+spritegen show   <character>     # what it holds, and what comes next
+spritegen status
+spritegen cost
+spritegen init                   # write the Claude skill for all of this
+```
+
+Every artifact of one character lives under `assets/<character>/`, and no stage takes an
+input or output path — that is what lets `status` say what comes next, and what lets a
+stage refuse to run out of order.
+
+`motion` is the one that answers the problem the rest of this exists for. Generating a
+walk frame by frame moves the character instead of animating it — measured on the purple
+warrior sheet, the head-and-torso region shifts 0.25 between steps against the
+reference's 0.11, because the model redraws the character in every cell. A pose-driven
+endpoint cannot: identity comes from the anchor, movement from a clip built out of a
+reference sheet the game already ships.
+
+Three endpoints do that job, and `--endpoint` picks one:
+
+| | |
+|---|---|
+| `wan-motion` (default) | retargets the driving skeleton to the character's proportions |
+| `wan-animate` | Wan 2.2 Animate, the full model |
+| `one-to-all` | weighs identity against pose, as two separate numbers |
+
+`init` spends nothing and is about the tool rather than about a character: it writes
+`.claude/skills/spritegen/SKILL.md` into the first `.claude` at or above the working
+directory — how to run the tool, the two routes through it, the prompt skeletons, and
+every option of every stage. The prose is authored at `src/spritegen/skill/files/SKILL.md`;
+the stage and endpoint tables are read out of the registry when the file is written, so a
+new option shows up in the skill without anyone remembering to describe it twice.
+
+Most stages spend money. Each paid call appends one line to that asset's `ledger.jsonl`
+with the endpoint, the exact payload, the URLs returned and the sha256 of every file
+written; `--dry-run` prints the payload and spends nothing.
+
+## Running it
+
+Needs [uv](https://docs.astral.sh/uv/) and `FAL_KEY`. Export it, or copy
+`.env.template` to `.env` and put it there — the CLI reads a `.env` from the working
+directory on start-up, and an exported variable wins over the file.
+
+One dependency is not on PyPI: `pixelfixer`, from
+[Retro-Diffusion/pixel-art-fixer](https://github.com/Retro-Diffusion/pixel-art-fixer),
+pinned to a commit in `uv.lock`. It recovers the native pixel grid an image already has
+and rewrites the image on it — the step that makes a 720p render into pixel art, and the
+reason `uv sync` needs git.
+
+```
+uv sync
+uv run spritegen --help
+uv run pytest
+uv run ruff check .
+```
+
+## Where the spec lives
+
+`specs/sprite-cli/`, in the workspace this tool was specified in, alongside the reference
+sheet it drives from. spritegen is a standalone CLI: it knows nothing about the game whose
+sprites it happens to have been built for, and nothing in it should.
+
+## Releasing
+
+Tag it. `git tag v0.2.0 && git push --tags` checks the tag agrees with the version in
+`pyproject.toml`, re-runs lint and tests, builds, smoke-tests both distributions with
+nothing supplied but the distribution itself, and attaches them to a GitHub Release.
+
+Publishing to PyPI is driven by one secret, `PUBLISH_TOKEN`, on the `pypi` environment —
+a project-scoped PyPI API token. **The secret is the switch**: without it the run says
+nothing was published and succeeds, and the distributions are on the Release either way.
+
+A long-lived token is a credential sitting in the repository until somebody rotates it.
+Trusted publishing avoids that entirely and is worth moving to; the release workflow's
+header says what it takes.