persista 0.0.1__tar.gz

persista-0.0.1/.gitignore

@@ -0,0 +1,218 @@
+# 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

persista-0.0.1/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, Thibaut Durand
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

persista-0.0.1/PKG-INFO

@@ -0,0 +1,289 @@
+Metadata-Version: 2.4
+Name: persista
+Version: 0.0.1
+Dynamic: Maintainer
+Dynamic: Maintainer-email
+Summary: library for persisting and caching data
+Project-URL: Homepage, https://github.com/durandtibo/persista
+Project-URL: Repository, https://github.com/durandtibo/persista
+Project-URL: Documentation, https://durandtibo.github.io/persista/
+Project-URL: Changelog, https://github.com/durandtibo/persista/releases
+Project-URL: Issues, https://github.com/durandtibo/persista/issues
+Author-email: Thibaut Durand <durand.tibo+gh@gmail.com>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Keywords: data,persist
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+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: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.10
+Requires-Dist: coola<2.0,>=1.1.9
+Provides-Extra: aiosqlite
+Requires-Dist: aiosqlite<1.0,>=0.20; extra == 'aiosqlite'
+Provides-Extra: all
+Requires-Dist: aiosqlite<1.0,>=0.20; extra == 'all'
+Requires-Dist: duckdb<2.0,>=1.3; extra == 'all'
+Requires-Dist: faker<41.0,>=40.0; extra == 'all'
+Requires-Dist: httpx<1.0,>=0.28; extra == 'all'
+Requires-Dist: lmdb<3.0,>=2.0; extra == 'all'
+Requires-Dist: psycopg[binary]<4.0,>=3.2; extra == 'all'
+Requires-Dist: redis[hiredis]<8.0,>=7.0; extra == 'all'
+Requires-Dist: requests<3.0,>=2.32; extra == 'all'
+Requires-Dist: rich<16.0,>=15.0; extra == 'all'
+Requires-Dist: urllib3<3.0,>=2.4; extra == 'all'
+Provides-Extra: duckdb
+Requires-Dist: duckdb<2.0,>=1.3; extra == 'duckdb'
+Provides-Extra: faker
+Requires-Dist: faker<41.0,>=40.0; extra == 'faker'
+Provides-Extra: httpx
+Requires-Dist: httpx<1.0,>=0.28; extra == 'httpx'
+Provides-Extra: lmdb
+Requires-Dist: lmdb<3.0,>=2.0; extra == 'lmdb'
+Provides-Extra: psycopg
+Requires-Dist: psycopg[binary]<4.0,>=3.2; extra == 'psycopg'
+Provides-Extra: redis
+Requires-Dist: redis[hiredis]<8.0,>=7.0; extra == 'redis'
+Provides-Extra: requests
+Requires-Dist: requests<3.0,>=2.32; extra == 'requests'
+Provides-Extra: rich
+Requires-Dist: rich<16.0,>=15.0; extra == 'rich'
+Provides-Extra: urllib3
+Requires-Dist: urllib3<3.0,>=2.4; extra == 'urllib3'
+Description-Content-Type: text/markdown
+
+# persista
+
+
+<p align="center">
+    <a href="https://github.com/durandtibo/persista/actions/workflows/ci.yaml">
+        <img alt="CI" src="https://github.com/durandtibo/persista/actions/workflows/ci.yaml/badge.svg">
+    </a>
+    <a href="https://github.com/durandtibo/persista/actions/workflows/nightly-tests.yaml">
+        <img alt="Nightly Tests" src="https://github.com/durandtibo/persista/actions/workflows/nightly-tests.yaml/badge.svg">
+    </a>
+    <a href="https://github.com/durandtibo/persista/actions/workflows/nightly-package.yaml">
+        <img alt="Nightly Package Tests" src="https://github.com/durandtibo/persista/actions/workflows/nightly-package.yaml/badge.svg">
+    </a>
+    <a href="https://codecov.io/gh/durandtibo/persista">
+        <img alt="Codecov" src="https://codecov.io/gh/durandtibo/persista/branch/main/graph/badge.svg">
+    </a>
+    <br/>
+    <a href="https://durandtibo.github.io/persista/">
+        <img alt="Documentation" src="https://github.com/durandtibo/persista/actions/workflows/docs.yaml/badge.svg">
+    </a>
+    <a href="https://durandtibo.github.io/persista/dev/">
+        <img alt="Documentation" src="https://github.com/durandtibo/persista/actions/workflows/docs-dev.yaml/badge.svg">
+    </a>
+    <br/>
+    <a href="https://github.com/psf/black">
+        <img  alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg">
+    </a>
+    <a href="https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings">
+        <img  alt="Doc style: google" src="https://img.shields.io/badge/%20style-google-3666d6.svg">
+    </a>
+    <a href="https://github.com/astral-sh/ruff">
+        <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff" style="max-width:100%;">
+    </a>
+    <a href="https://github.com/guilatrova/tryceratops">
+        <img  alt="try/except style: tryceratops" src="https://img.shields.io/badge/try%2Fexcept%20style-tryceratops%20%F0%9F%A6%96%E2%9C%A8-black">
+    </a>
+    <br/>
+    <a href="https://pypi.org/project/persista/">
+        <img alt="PYPI version" src="https://img.shields.io/pypi/v/persista">
+    </a>
+    <a href="https://pypi.org/project/persista/">
+        <img alt="Python" src="https://img.shields.io/pypi/pyversions/persista.svg">
+    </a>
+    <a href="https://opensource.org/licenses/BSD-3-Clause">
+        <img alt="BSD-3-Clause" src="https://img.shields.io/pypi/l/persista">
+    </a>
+    <br/>
+    <a href="https://pepy.tech/project/persista">
+        <img  alt="Downloads" src="https://static.pepy.tech/badge/persista">
+    </a>
+    <a href="https://pepy.tech/project/persista">
+        <img  alt="Monthly downloads" src="https://static.pepy.tech/badge/persista/month">
+    </a>
+    <br/>
+</p>
+
+## Overview
+
+`persista` is a lightweight Python library that provides simple, consistent building blocks for
+persisting and caching data. It offers a uniform key-value store interface backed by multiple
+storage engines (in-memory, SQLite, DuckDB, LMDB, Redis, PostgreSQL) with both sync and async
+APIs, plus TTL caching and HTTP fetch utilities.
+
+**Quick Links:**
+
+- [Documentation](https://durandtibo.github.io/persista/)
+- [Installation](#installation)
+- [Features](#features)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Why persista?
+
+Storage backends have different APIs, and switching between them (e.g. moving from an in-memory
+store in tests to Redis or PostgreSQL in production) usually means rewriting code. `persista`
+solves this with a single, consistent `BaseStore` interface:
+
+**Store and retrieve values:**
+
+```pycon
+>>> from persista.store import InMemoryStore
+>>> store = InMemoryStore()
+>>> store.set("user:1", {"name": "Alice"})
+>>> store.get("user:1")
+{'name': 'Alice'}
+
+```
+
+**Swap the backend without changing the calling code:**
+
+```pycon
+>>> import tempfile
+>>> from pathlib import Path
+>>> from persista.store import SQLiteStore
+>>> with tempfile.TemporaryDirectory() as tmpdir:
+...     with SQLiteStore(Path(tmpdir).joinpath("data.sqlite")) as store:
+...         store.set("user:1", {"name": "Alice"})
+...         store.get("user:1")
+...
+{'name': 'Alice'}
+
+```
+
+**Cache expensive calls with a TTL:**
+
+```pycon
+>>> from persista.cache import cached
+>>> @cached(ttl=60)
+... def slow_call(x: int) -> int:
+...     return x**2
+...
+>>> slow_call(4)
+16
+
+```
+
+See the [documentation](https://durandtibo.github.io/persista/) for detailed examples.
+
+## Features
+
+`persista` provides a comprehensive set of utilities for persisting and caching data:
+
+### 🗄️ **Key-Value Stores**
+
+A consistent `BaseStore` / `AsyncBaseStore` interface for storing dict values under string keys:
+
+- Uniform API across backends: `get`, `get_many`, `set`, `set_many`, `delete`, `filter`, iteration
+- Sync backends: `InMemoryStore`, `SQLiteStore`, `DuckDBStore`, `LmdbStore`, `RedisStore`, `PostgresStore`
+- Async backends: `AsyncInMemoryStore`, `AsyncSQLiteStore`, `AsyncRedisStore`, `AsyncPostgresStore`
+- Typed variants (`TypedSQLiteStore`, `TypedPostgresStore`, ...) and pickle-backed variants
+  (`PickleLmdbStore`, `PickleRedisStore`, `AsyncPickleRedisStore`) for non-dict values
+- Configurable conflict handling on writes (`"raise"`, `"skip"`, `"overwrite"`)
+
+### ⏱️ **TTL Caching**
+
+Time-to-live caching for functions and values, with sync and async variants:
+
+- `TTLCache` and `AsyncTTLCache` for explicit cache instances
+- `cached` / `async_cached` decorators for caching function calls
+- Shared default caches via `get_ttl_cache` / `get_async_ttl_cache`
+
+### 🌐 **HTTP Utilities**
+
+Helpers to fetch HTTP responses with automatic retries, built on top of `requests` or `httpx`:
+
+- `fetch_response` (sync, `requests`) and `fetch_response_async` (async, `httpx`)
+
+## Installation
+
+We highly recommend installing `persista` in
+a [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/)
+to avoid dependency conflicts.
+
+### Using uv (recommended)
+
+[`uv`](https://docs.astral.sh/uv/) is a fast Python package installer and resolver:
+
+```shell
+uv pip install persista
+```
+
+**Install with specific optional dependencies:**
+
+```shell
+uv pip install persista[redis,httpx]  # with Redis and httpx support
+```
+
+### Using pip
+
+Alternatively, you can use `pip`:
+
+```shell
+pip install persista
+```
+
+**Install with specific optional dependencies:**
+
+```shell
+pip install persista[redis,httpx]  # with Redis and httpx support
+```
+
+### Requirements
+
+- **Python**: 3.10 or higher
+- **Core dependencies**: [`coola`](https://github.com/durandtibo/coola)
+
+**Optional dependencies**, enabled per-backend:
+
+| Extra       | Enables                              |
+|-------------|---------------------------------------|
+| `aiosqlite` | Async SQLite store                    |
+| `duckdb`    | DuckDB store                          |
+| `faker`     | Test data generation helpers          |
+| `httpx`     | Async HTTP fetch utilities            |
+| `lmdb`      | LMDB store                            |
+| `psycopg`   | PostgreSQL store                      |
+| `redis`     | Redis store                           |
+| `requests`  | Sync HTTP fetch utilities             |
+| `rich`      | Rich-formatted output                 |
+| `urllib3`   | urllib3-based HTTP utilities          |
+
+For detailed installation instructions, see the [documentation](https://durandtibo.github.io/persista/).
+
+## Contributing
+
+Contributions are welcome! We appreciate bug fixes, feature additions, documentation improvements,
+and more. Please check the [contributing guidelines](CONTRIBUTING.md) for details on:
+
+- Setting up the development environment
+- Code style and testing requirements
+- Submitting pull requests
+
+Whether you're fixing a bug or proposing a new feature, please open an issue first to discuss
+your changes.
+
+## API Stability
+
+:warning: **Important**: As `persista` is under active development, its API is not yet stable and may
+change between releases. We recommend pinning a specific version in your project’s dependencies to
+ensure consistent behavior.
+
+## License
+
+`persista` is licensed under BSD 3-Clause "New" or "Revised" license available in [LICENSE](LICENSE)
+file.