Metadata-Version: 2.3
Name: index.toml
Version: 0.2.0
Summary: Python API and CLI for ecosystem-neutral package indexes
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Requires-Dist: index-toml-cli>=0.2.0,<0.3
Requires-Dist: index-toml-core>=0.2.0,<0.3
Requires-Python: >=3.10, <3.16
Project-URL: Repository, https://github.com/groupsum/index.toml
Description-Content-Type: text/markdown

# index.toml

Use `index-toml validate` to validate `pkgs/index.toml` from the repository root. The global `--file` option selects another path. Run `index-toml --help` for the available commands.

The `index-toml` entry point forwards to the CLI implementation in `index.toml-cli`.

`from index_toml import IndexFile` provides file-backed validation and CRUD for layers and packages. Call `initialize()` to create an empty index. Add operations take an ID and explicit order. Package creation also takes a layer and path. Updates patch fields and use `None` to remove optional fields. Read operations return decoded dictionaries.

Each edit locks the index for cooperating writers, validates the whole candidate document, and replaces the file atomically. To delete a referenced record, update the records that refer to it first.
