Installation
Requirements
Section titled “Requirements”- Python 3.11 or later
- The
cryptographylibrary (installed automatically)
Install
Section titled “Install”pip install synpareiaOr with uv:
uv add synpareiaOptional dependencies
Section titled “Optional dependencies”SQLite storage backend
Section titled “SQLite storage backend”For persistent chain storage using SQLite:
pip install synpareia[sqlite]This adds aiosqlite for async SQLite operations. Without it, chains use in-memory storage (fast but ephemeral).
Verify installation
Section titled “Verify installation”import synpareiaprint(synpareia.__version__) # 0.1.0
# Quick smoke testprofile = synpareia.generate()chain = synpareia.create_chain(profile)block = synpareia.create_block(profile, "message", "test")chain.append(block)valid, _ = chain.verify()assert validprint("synpareia is working")For development
Section titled “For development”If you’re contributing to synpareia:
git clone https://github.com/synpareia/synpareia.gitcd synpareiauv sync --extra devmake testSee CONTRIBUTING.md for the full development workflow.
Built by Sam Hyland · Canberra, Australia