aiosyncthing

What it is and what it does

aiosyncthing is an async Python wrapper around the Syncthing REST API, built on aiohttp and yarl. It provides namespace-organized access to Syncthing's system endpoints (ping, status, version, pause/resume), config endpoints (folders, devices), database endpoints (folder status), and event endpoints (long-polling listener). The package is designed for integration into async Python applications that need to monitor or control Syncthing instances programmatically.

The library is in active development but not feature-complete—not all Syncthing API endpoints are implemented. It handles authentication via API key, supports custom base URLs and SSL verification settings, and manages connection timeouts and event reconnection internally. Errors are raised as typed exceptions (SyncthingError, PingError, UnknownDeviceError, UnknownFolderError) to allow granular error handling.

Use it for:

• Monitor Syncthing server status and sync progress in real-time from a Python application
• Pause or resume synchronization programmatically based on external conditions or schedules
• Listen to Syncthing events (file changes, device connections) and trigger downstream workflows
• Query folder and device configuration to build dashboards or automation tools
• Integrate Syncthing management into larger async Python services or orchestration platforms

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Asynchronous Python client for the Syncthing REST API, providing async/await access to system, config, database, and event endpoints.

Yes, with conditions. Install if you need async Syncthing API access in a Python application and can tolerate incomplete API coverage. The low install friction, permissive MIT license, and recent maintenance activity make it a reasonable choice. However, the aging maintenance status (207 days since last release, 10 repository stars) and acknowledged incomplete feature set mean you should verify that the endpoints you need are implemented before committing to it.

Install

aiosyncthing on PyPI

pip install aiosyncthing

uv add aiosyncthing

poetry add aiosyncthing

Installing aiosyncthing

Before you install

Low install friction with only two lightweight runtime dependencies (aiohttp and yarl). Maintenance is aging—last release was 207 days ago and the repository shows minimal activity (10 stars), though it remains unarchived and the last commit is recent.

License in practice

MIT License (permissive) allows free use, modification, and distribution with minimal restrictions, making it suitable for both open-source and commercial projects.

Quickstart

pip install aiosyncthing

import asyncio
from aiosyncthing import Syncthing

async def main():
    async with Syncthing("API Key") as client:
        await client.system.ping()

asyncio.run(main())

Requires a running Syncthing instance with a valid API key; SSL verification can be disabled via verify_ssl parameter if needed.

Verify before relying

• Extent of unimplemented API features beyond what the description excerpt documents
• Performance characteristics under high-frequency event polling or large folder counts
• Compatibility with Syncthing server versions beyond those tested during development

Package facts

Evidence: aiosyncthing-0.7.1-py3-none-any.whl

Keywords: syncthing, sync, rest, backup, api, aio, async, await

Tags

More Mirroring packages