synology-apm-repo-sdk
Offline, read-only Python SDK for the Synology APV/Object-Storage dedup backup repository on-disk format. No network access, no writes to the repository — it only decodes what's already on disk (local filesystem, a mounted S3/Azure object store, or an SMB share) into browsable catalogs, workloads, versions, and restorable files.
Install
uv add synology-apm-repo-sdk # inside a uv project
pip install synology-apm-repo-sdk # any other environment
Full API reference: https://synology-apm.github.io/apm-repo-sdk-python/
Usage
import asyncio
from synology_apm_repo.sdk import Session
async def main() -> None:
async with Session() as session:
for repo in await session.open("/path/to/repository"):
if repo.is_encrypted:
result = await repo.set_key("<userKeyID>@<base64 userKey>")
if not result.verification.ok:
print(f"wrong key for {repo}")
continue
for catalog in await repo.catalogs():
for workload in await catalog.workloads():
for version in await catalog.versions(workload):
print(catalog.display_name, workload.display_name, version.display_name)
asyncio.run(main())
Everything the SDK does is async def; Session is the entry point, and
closing it (or leaving its async with) closes every repository it handed
out. See ARCHITECTURE.md's Repository Layer section for what Repository/
Catalog each represent.
Requirements
Python 3.12+.
License
Apache-2.0.
Metadata
Release files for synology-apm-repo-sdk 0.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| synology_apm_repo_sdk-0.4.0.tar.gz | 333.9 kB | With provenance | Details for synology_apm_repo_sdk-0.4.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| synology_apm_repo_sdk-0.4.0-py3-none-any.whl | Python 3 | none | any | Details for synology_apm_repo_sdk-0.4.0-py3-none-any.whl |
Total release size: 756.6 kB
Release files / synology_apm_repo_sdk-0.4.0.tar.gz
| Download URL | synology_apm_repo_sdk-0.4.0.tar.gz |
|---|---|
| Size | 333.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
884dd91352c0fdd57b030642fd01b3347b7861a809e4f0fd7d8827c792a63447
|
|
BLAKE2b-256 checksum How to use checksums |
8d6c97226ea693a147b3e30cd965147650c1ee7d005a262d50aaecbac003b9f4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 24, 2026.
Transparency logRelease files / synology_apm_repo_sdk-0.4.0-py3-none-any.whl
| Download URL | synology_apm_repo_sdk-0.4.0-py3-none-any.whl |
|---|---|
| Size | 422.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2b5f24aca03378f5414fe8825d1c41d136edf12e337f5745dba0822a20e67e0b
|
|
BLAKE2b-256 checksum How to use checksums |
f3e640e2d6d573ce593742249037d0ecf973374dc378bf0b4b6b699aa3454c6b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 24, 2026.
Transparency logSecurity for synology-apm-repo-sdk 0.4.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for synology_apm_repo_sdk-0.4.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 24, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.