Skip to main content

Python SDK for Filecoin Onchain Cloud (Synapse)

Project description

Pynapse

Python SDK for Filecoin Onchain Cloud (Synapse).

This project mirrors the JS SDK in FilOzone/synapse-sdk and references the Go implementation in data-preservation-programs/go-synapse for parity.

Status

Work in progress. Parity is being implemented in incremental commits.

Install (dev)

uv venv
uv pip install -e .[test]

PyPI package name: synapse-filecoin-sdk
Python import: pynapse

Install (PyPI)

pip install synapse-filecoin-sdk

CommP / PieceCID

pynapse uses stream-commp from go-fil-commp-hashhash for PieceCID calculation. Set PYNAPSE_COMMP_HELPER to override the helper path.

License

Dual-licensed under Apache-2.0 OR MIT. See LICENSE.md.

Publishing to PyPI

Publishing is automated via GitHub Actions in .github/workflows/publish-pypi.yml.

  1. In PyPI, create the project (or use an existing one) and configure a Trusted Publisher for this GitHub repository and workflow.
  2. In GitHub, optionally protect the pypi environment for manual approval.
  3. Tag a release and push the tag:
git tag v0.1.1
git push origin v0.1.1

The workflow builds the package, runs twine check, and publishes to PyPI via OIDC (no API token required).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

synapse_filecoin_sdk-0.1.0.tar.gz (189.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

synapse_filecoin_sdk-0.1.0-py3-none-any.whl (86.5 kB view details)

Uploaded Python 3

File details

Details for the file synapse_filecoin_sdk-0.1.0.tar.gz.

File metadata

  • Download URL: synapse_filecoin_sdk-0.1.0.tar.gz
  • Upload date:
  • Size: 189.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for synapse_filecoin_sdk-0.1.0.tar.gz
Algorithm Hash digest
SHA256 fe2184a851700626199a3545750ca4937fa9bd7facdb0daf8f0cd3c1c4a95638
MD5 64eca611c36327d8b2c922f836c5c5cf
BLAKE2b-256 e97293bf3113ca8462f55a8990479fc2daa94d7e76cc581e87c971f4e1a1e114

See more details on using hashes here.

Provenance

The following attestation bundles were made for synapse_filecoin_sdk-0.1.0.tar.gz:

Publisher: publish-pypi.yml on anjor/pynapse

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file synapse_filecoin_sdk-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for synapse_filecoin_sdk-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 17bc1cbb7f140c7e532b16f742439e768fa90cdd58baad9bb87e41aaa42f6627
MD5 41cef316d4e890a3a09a72b7cb984347
BLAKE2b-256 1bcf2737539a72486c1e9673149bc81cbb95fb018644ec363f741dbe37ea25b2

See more details on using hashes here.

Provenance

The following attestation bundles were made for synapse_filecoin_sdk-0.1.0-py3-none-any.whl:

Publisher: publish-pypi.yml on anjor/pynapse

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page