Metadata-Version: 2.3
Name: syncwave
Version: 0.3.0
Summary: Turn plain JSON files into a live data store, two-way synced with your Python objects.
Keywords: 
Author: Lucas Iannitello
Author-email: Lucas Iannitello <lucas.iannitello@protonmail.com>
License: MIT License
         
         Copyright (c) 2026 Lucas Iannitello
         
         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.
Requires-Dist: pydantic>=2.13.5
Requires-Dist: typing-extensions>=4.16.0
Requires-Dist: watchdog>=6.0.0
Requires-Python: >=3.10
Project-URL: Homepage, https://github.com/iannitello/syncwave
Project-URL: Issues, https://github.com/iannitello/syncwave/issues
Project-URL: Repository, https://github.com/iannitello/syncwave
Description-Content-Type: text/markdown

# Syncwave

Turn plain JSON files into a live data store, two-way synced with your Python objects.

## Documentation

Read the docs at https://syncwave.dev/.

A few useful links:

- [Cheat Sheet](https://syncwave.dev/cheat_sheet/)
- [Usage Guide](https://syncwave.dev/usage/syncwave/)
- [API Reference](https://syncwave.dev/api/syncwave/)

## Installation

Install from [PyPI](https://pypi.org/project/syncwave/).

```shell
# uv
uv add syncwave

# pip
pip install syncwave
```

## What Is Syncwave

Syncwave keeps in-memory Python objects and JSON files synchronized, in both directions:

- Change your data from Python (an `append`, a dict assignment, a model field update) and the JSON file is updated.
- Edit the JSON file, by hand or from another process, and your Python objects are updated in place.
- Every change, from either side, is validated with [Pydantic](https://pydantic.dev/docs/validation/latest/get-started/) against the store's declared type.

You get persistence with _zero_ setup: no database to install, no ORM, no serialization code. Your data lives in JSON files you can open and edit at any time.

If you know Python type hints and Pydantic models, you already know everything you need.

Requires Python 3.10+.

## Versioning

Syncwave is under active development, and until version 1.0, new releases may introduce backward-incompatible changes.

## License

Syncwave is licensed under the MIT License.
