https://github.com/blakev/python-syncthing
Python bindings to the Syncthing REST interface.
https://github.com/blakev/python-syncthing
python rest-api rest-client syncthing
Last synced: 3 months ago
JSON representation
Python bindings to the Syncthing REST interface.
- Host: GitHub
- URL: https://github.com/blakev/python-syncthing
- Owner: blakev
- License: mit
- Created: 2015-05-07T17:48:07.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2022-12-05T18:15:52.000Z (over 3 years ago)
- Last Synced: 2025-12-13T05:46:51.616Z (4 months ago)
- Topics: python, rest-api, rest-client, syncthing
- Language: Python
- Size: 99.6 KB
- Stars: 81
- Watchers: 8
- Forks: 23
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
python-syncthing
================
[](https://pypi.python.org/pypi/syncthing)
[](https://syncthing.net)
[](http://python-syncthing.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/blakev/python-syncthing/blob/master/LICENSE)
Python bindings to the Syncthing REST interface.
- [Python API Documentation](http://python-syncthing.readthedocs.io/en/latest/)
- [Syncthing](https://syncthing.net/)
- [Syncthing REST Documentation](https://docs.syncthing.net/dev/rest.html)
- [Syncthing Forums](https://forum.syncthing.net/)
```bash
$ pip install syncthing
```
## Getting Started
```python
from syncthing import Syncthing
API_KEY = "..."
s = Syncthing(API_KEY)
# name spaced by API endpoints
s.system.connections()
# supports GET/POST semantics
sync_errors = s.system.errors()
s.system.clear()
if sync_errors:
for e in sync_errors:
print(e)
# supports event long-polling
event_stream = s.events(limit=10)
for event in event_stream:
# do something with `event`
if event_stream.count > 100:
event_stream.stop()
```
## Running Tests
The API doctests rely on the following function to run against your instance.
None of the "breaking" calls will be tested. You must set the following environment
variables otherwise all tests will fail.
```python
def _syncthing():
KEY = os.getenv('SYNCTHING_API_KEY')
HOST = os.getenv('SYNCTHING_HOST', '127.0.0.1')
PORT = os.getenv('SYNCTHING_PORT', 8384)
IS_HTTPS = bool(int(os.getenv('SYNCTHING_HTTPS', '0')))
SSL_CERT_FILE = os.getenv('SYNCTHING_CERT_FILE')
return Syncthing(KEY, HOST, PORT, 10.0, IS_HTTPS, SSL_CERT_FILE)
```
## License
> The MIT License (MIT)
>
> Copyright (c) 2015-2017 Blake VandeMerwe
>
> Permission is hereby granted, free of charge, to any person obtaining a copy
> of this software and associated documentation files (the "Software"), to deal
> in the Software without restriction, including without limitation the rights
> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
> copies of the Software, and to permit persons to whom the Software is
> furnished to do so, subject to the following conditions:
> The above copyright notice and this permission notice shall be included in all
> copies or substantial portions of the Software.
>
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
> SOFTWARE.