Metadata-Version: 2.4
Name: glyff-file-store
Version: 0.10.0
Summary: File-based SessionStore implementation for glyff.
License: MIT License
        
        Copyright (c) 2026 nueruyu
        
        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.
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: AsyncIO
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Typing :: Typed
Requires-Python: >=3.11
Requires-Dist: glyff>=0.1.0
Description-Content-Type: text/markdown

# glyff-file-store

A file-based `SessionStore` implementation for
[glyff](https://pypi.org/project/glyff/).

Sessions are persisted to disk as a JSON event log. The whole log is loaded
into memory at startup and the file is rewritten atomically on each commit;
suitable for sessions where the log fits comfortably in memory. For very
large or high-throughput sessions, prefer a database-backed store.

## Install

```bash
pip install glyff-file-store
```

This package depends on `glyff>=0.1.0`.

## Public API

| Name                   | Description                                                  |
| ---------------------- | ------------------------------------------------------------ |
| `FileClient`           | Low-level file I/O for a session directory.                  |
| `JsonFileSessionStore` | `SessionStore` writing a pretty-printed JSON event log file. |

## Format

Each session lives under `<base_dir>/<session_id>/` and stores its event log
in a single pretty-printed JSON file (`executions.json`). The whole log is
read into memory on startup and rewritten atomically on every commit.

## Commit atomicity

`FileClient` commits the staged ops for an entire session directory as a unit.
Each commit builds the full new session state in a sibling `.commit-*`
directory and then swaps it into place via two renames (`session` →
`session.bak`, `tmp` → `session`, drop `session.bak`). All staged ops are
visible together or none are, regardless of how many files were touched, and
a writer callback raising mid-commit leaves the on-disk session unchanged.

If a process dies mid-commit, the next `FileClient(...)` instantiation
restores the session from `session.bak` (when the live directory is missing)
or drops the stale backup (when the live directory is already in place), and
removes any orphan `.commit-*` temp directories.

## Status

Early development. APIs may change before v1.0.

## License

MIT
