Skip to content

Installation

  • Python 3.11 or later
  • The cryptography library (installed automatically)
Terminal window
pip install synpareia

Or with uv:

Terminal window
uv add synpareia

For persistent chain storage using SQLite:

Terminal window
pip install synpareia[sqlite]

This adds aiosqlite for async SQLite operations. Without it, chains use in-memory storage (fast but ephemeral).

import synpareia
print(synpareia.__version__) # 0.1.0
# Quick smoke test
profile = synpareia.generate()
chain = synpareia.create_chain(profile)
block = synpareia.create_block(profile, "message", "test")
chain.append(block)
valid, _ = chain.verify()
assert valid
print("synpareia is working")

If you’re contributing to synpareia:

Terminal window
git clone https://github.com/synpareia/synpareia.git
cd synpareia
uv sync --extra dev
make test

See CONTRIBUTING.md for the full development workflow.

Built by Sam Hyland · Canberra, Australia