assetcat 1.0.0__tar.gz

assetcat-1.0.0/.gitignore

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

assetcat-1.0.0/CLAUDE.md

@@ -0,0 +1,76 @@
+# AssetCat (`assetcat`)
+
+An indexer, CLI and local browse UI for big game asset libraries, with licenses and AI provenance
+kept in plain files. MIT open source, built with Claude Code. README.md covers usage; pull
+requests aren't accepted for now (feature requests come in as issues).
+
+## Layout
+
+- `src/assetcat/`: the package. `config` (user config, library/profile/cache lookup, the write
+  guard), `init` (layout detection, starter profile), `scan` (walk, groups, pack tree),
+  `classify` (file categories, asset types, variant keys; pure functions), `extract` (per-file
+  metadata, runs in worker processes), `grids`, `sheets` (contact sheets), `curation` (reads the
+  profile), `edit` (curation writes with tomlkit, shortlists), `indexer` (the pipeline), `db`
+  (schema), `cli`, `server` (FastAPI: JSON API, file and thumbnail serving), `pull` (copy
+  assets into a project with licenses and a manifest), `ai` (pack tags from a vision model over an
+  OpenAI-compatible API, result shards in the profile's `ai/`, tag vocabulary and override layers).
+  `embed` (image vectors from a SigLIP 2 model in-process, the optional `ai` extra; shards in
+  `ai/<model>/`, search by meaning and "more like this" in NumPy).
+- `src/assetcat/web/`: the UI, a no-build Preact + htm page; `vendor/` is checked in.
+  `model3d.js` (three.js viewer and thumbnail renders) is imported only when a 3D model shows.
+- `src/assetcat/starter/`: files `assetcat init` copies into a new profile.
+- `skills/assetcat/SKILL.md`: the generic Claude skill (search, check, pull, credits). Keep it in
+  step with the CLI: when a command or flag changes, update the skill too.
+- `tests/`: pytest. `make_library.py` generates the synthetic library every test runs on.
+- `scripts/ui_check.py`: Playwright checks against a running `assetcat serve` (Chrome, headless).
+
+## Rules
+
+- **The library is read-only.** The only place the tool writes inside the library is the
+  profile folder; every such write goes through `Config.writable()` (or `ensure_inside` in init).
+  `pull` writes only to its destination and manifest, and refuses both inside the library. Tests
+  check the library is byte-for-byte unchanged after init, index, edits and pulls.
+- **The database is disposable.** It's a cache built from the library plus the profile, never
+  the only home of anything. No migrations: derived tables are rebuilt on every `index`; only
+  `files` persists, and changing it means bumping `db.SCHEMA_VERSION` (drop and rebuild).
+  `extract.META_VERSION` with `META_MIN` (every file) or `META_MIN_BY_CATEGORY` (one category)
+  forces re-extraction; `db.DERIVED_VERSION` (bump it when the derived tables change) makes
+  commands ask for an `index` instead of failing on an old one. Anything a human decided or that
+  is expensive to compute goes in the profile.
+- **Profile files** carry `format = N` (missing means 1). Read older formats; refuse newer ones.
+  Edits must keep the user's comments and layout: an edit followed by its reverse leaves the file
+  byte-identical (tested).
+- **No personal data in the repo:** no absolute paths of a real machine, no real purchase
+  details, no real curation content. Examples and tests use the synthetic library.
+- **Cross-platform:** macOS, Windows and Linux (CI runs all three). Library paths in the
+  database are `/`-separated and relative; use `cfg.abs()` / `cfg.fs()` for file system access
+  (`fs()` is long-path safe on Windows). Write text files with `newline="\n"`.
+- The server binds to 127.0.0.1 by default because it can edit curation files, and only serves
+  library files that are in the index.
+
+## Commands
+
+```sh
+uv sync                                     # dev environment (--extra ai adds PyTorch for embeddings)
+uv run pytest                               # all tests (a few seconds)
+uv run assetcat ...                         # the CLI from this checkout
+uv run --with playwright python scripts/ui_check.py http://127.0.0.1:8765/ --shots /tmp/shots
+```
+
+Use uv for everything Python. To try things on a library without touching your own config, set
+`ASSETCAT_CONFIG` and `ASSETCAT_CACHE` to scratch paths and run `assetcat init` on a library made
+with `tests/make_library.py`.
+
+## Releases
+
+Bump `version` in `pyproject.toml` and `src/assetcat/__init__.py`, commit, then tag `vX.Y.Z` and
+push the tag. CI tests it on all three systems and publishes it to PyPI (trusted publishing,
+the `publish` job in `ci.yml`; it refuses a tag that doesn't match the version). A published
+version can't be replaced, only yanked: fix forward with the next patch version. Other repos pin
+a version with `uvx assetcat@X.Y.Z`.
+
+## Workflow
+
+- Commit only when asked.
+- After changing the UI or server, run the UI check against a real `assetcat serve`, not only
+  the tests.

assetcat-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Mirko Froehlich
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.