synology-api 0.7.2__tar.gz → 0.8__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- synology_api-0.8/PKG-INFO +150 -0
- synology_api-0.8/README.md +124 -0
- {synology-api-0.7.2 → synology_api-0.8}/setup.py +2 -2
- {synology-api-0.7.2 → synology_api-0.8}/synology_api/__init__.py +6 -1
- synology_api-0.8/synology_api/abm.py +1004 -0
- {synology-api-0.7.2 → synology_api-0.8}/synology_api/auth.py +175 -19
- synology_api-0.8/synology_api/base_api.py +94 -0
- synology_api-0.8/synology_api/cloud_sync.py +1466 -0
- synology_api-0.8/synology_api/core_active_backup.py +185 -0
- synology_api-0.8/synology_api/core_backup.py +314 -0
- {synology-api-0.7.2 → synology_api-0.8}/synology_api/core_certificate.py +88 -3
- synology_api-0.8/synology_api/core_group.py +705 -0
- synology_api-0.8/synology_api/core_package.py +1078 -0
- synology_api-0.8/synology_api/core_share.py +846 -0
- {synology-api-0.7.2 → synology_api-0.8}/synology_api/core_sys_info.py +20 -37
- synology_api-0.8/synology_api/core_user.py +765 -0
- synology_api-0.8/synology_api/directory_server.py +915 -0
- {synology-api-0.7.2 → synology_api-0.8}/synology_api/downloadstation.py +15 -7
- synology_api-0.8/synology_api/error_codes.py +780 -0
- synology_api-0.8/synology_api/event_scheduler.py +448 -0
- {synology-api-0.7.2 → synology_api-0.8}/synology_api/exceptions.py +58 -3
- {synology-api-0.7.2 → synology_api-0.8}/synology_api/filestation.py +85 -14
- {synology-api-0.7.2 → synology_api-0.8}/synology_api/photos.py +41 -15
- synology_api-0.8/synology_api/snapshot.py +304 -0
- {synology-api-0.7.2 → synology_api-0.8}/synology_api/surveillancestation.py +3 -3
- synology_api-0.8/synology_api/task_scheduler.py +1754 -0
- synology_api-0.8/synology_api/usb_copy.py +192 -0
- synology_api-0.8/synology_api/utils.py +35 -0
- synology_api-0.8/synology_api.egg-info/PKG-INFO +150 -0
- {synology-api-0.7.2 → synology_api-0.8}/synology_api.egg-info/SOURCES.txt +11 -0
- synology_api-0.8/synology_api.egg-info/requires.txt +7 -0
- synology_api-0.8/tests/test_add_s3_sync_task.py +86 -0
- synology_api-0.8/tests/test_core_user.py +263 -0
- {synology-api-0.7.2 → synology_api-0.8}/tests/test_syno_api.py +10 -1
- synology-api-0.7.2/PKG-INFO +0 -724
- synology-api-0.7.2/README.md +0 -710
- synology-api-0.7.2/synology_api/base_api.py +0 -32
- synology-api-0.7.2/synology_api/core_active_backup.py +0 -52
- synology-api-0.7.2/synology_api/core_backup.py +0 -63
- synology-api-0.7.2/synology_api/directory_server.py +0 -798
- synology-api-0.7.2/synology_api/error_codes.py +0 -228
- synology-api-0.7.2/synology_api/snapshot.py +0 -261
- synology-api-0.7.2/synology_api/usb_copy.py +0 -47
- synology-api-0.7.2/synology_api.egg-info/PKG-INFO +0 -724
- synology-api-0.7.2/synology_api.egg-info/requires.txt +0 -3
- {synology-api-0.7.2 → synology_api-0.8}/LICENSE.txt +0 -0
- {synology-api-0.7.2 → synology_api-0.8}/setup.cfg +0 -0
- {synology-api-0.7.2 → synology_api-0.8}/synology_api/audiostation.py +0 -0
- {synology-api-0.7.2 → synology_api-0.8}/synology_api/dhcp_server.py +0 -0
- {synology-api-0.7.2 → synology_api-0.8}/synology_api/docker_api.py +0 -0
- {synology-api-0.7.2 → synology_api-0.8}/synology_api/drive_admin_console.py +0 -0
- {synology-api-0.7.2 → synology_api-0.8}/synology_api/log_center.py +0 -0
- {synology-api-0.7.2 → synology_api-0.8}/synology_api/notestation.py +0 -0
- {synology-api-0.7.2 → synology_api-0.8}/synology_api/oauth.py +0 -0
- {synology-api-0.7.2 → synology_api-0.8}/synology_api/security_advisor.py +0 -0
- {synology-api-0.7.2 → synology_api-0.8}/synology_api/universal_search.py +0 -0
- {synology-api-0.7.2 → synology_api-0.8}/synology_api/virtualization.py +0 -0
- {synology-api-0.7.2 → synology_api-0.8}/synology_api/vpn.py +0 -0
- {synology-api-0.7.2 → synology_api-0.8}/synology_api.egg-info/dependency_links.txt +0 -0
- {synology-api-0.7.2 → synology_api-0.8}/synology_api.egg-info/top_level.txt +0 -0
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
Metadata-Version: 2.2
|
|
2
|
+
Name: synology-api
|
|
3
|
+
Version: 0.8
|
|
4
|
+
Summary: Python Synology API Wrapper
|
|
5
|
+
Home-page: https://github.com/N4S4/synology-api
|
|
6
|
+
Author: Renato Visaggio
|
|
7
|
+
Author-email: synology.python.api@gmail.com
|
|
8
|
+
License: MIT
|
|
9
|
+
Description-Content-Type: text/markdown
|
|
10
|
+
License-File: LICENSE.txt
|
|
11
|
+
Requires-Dist: requests
|
|
12
|
+
Requires-Dist: urllib3
|
|
13
|
+
Requires-Dist: setuptools
|
|
14
|
+
Requires-Dist: requests_toolbelt
|
|
15
|
+
Requires-Dist: tqdm
|
|
16
|
+
Requires-Dist: cryptography
|
|
17
|
+
Requires-Dist: treelib
|
|
18
|
+
Dynamic: author
|
|
19
|
+
Dynamic: author-email
|
|
20
|
+
Dynamic: description
|
|
21
|
+
Dynamic: description-content-type
|
|
22
|
+
Dynamic: home-page
|
|
23
|
+
Dynamic: license
|
|
24
|
+
Dynamic: requires-dist
|
|
25
|
+
Dynamic: summary
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+

|
|
29
|
+
<img alt="Pepy Total Downloads" src="https://img.shields.io/pepy/dt/synology-api?color=blue">
|
|
30
|
+
<img alt="Website" src="https://img.shields.io/website?url=https%3A%2F%2Fn4s4.github.io%2Fsynology-api&label=docs&color=green">
|
|
31
|
+
|
|
32
|
+
<img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/n4s4/synology-api">
|
|
33
|
+
<img alt="GitHub License" src="https://img.shields.io/github/license/n4s4/synology-api">
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
# Synology Wrapper
|
|
37
|
+
|
|
38
|
+
If you find yourself here, most probably you are trying to develop something for your NAS, this wrapper might come to your help to build your script.
|
|
39
|
+
|
|
40
|
+
I would like to specify that I do this for hobby as is my passion and in my little free time.
|
|
41
|
+
|
|
42
|
+
Said this, there is no warranties chained and this library is provided "As Is", you will find many things can be simplified, and I slowly will but feel free to [Contribute](https://n4s4.github.io/synology-api/docs/contribute).
|
|
43
|
+
|
|
44
|
+
## Premise
|
|
45
|
+
|
|
46
|
+
I've tried this wrapper only with `python3`.
|
|
47
|
+
I do not know if it actually runs with previous versions
|
|
48
|
+
|
|
49
|
+
Before opening an issue make sure you do your own research, if you are not sure, write me.
|
|
50
|
+
|
|
51
|
+
## Installation
|
|
52
|
+
|
|
53
|
+
The package is distributed via pip3, but it can also be installed from source.
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
pip3 install synology-api
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
or
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
pip3 install git+https://github.com/N4S4/synology-api
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
## Basic Usage
|
|
67
|
+
Here is a basic example on how to use the package, check [Getting Started - Basic Usage](https://n4s4.github.io/synology-api/docs/getting-started/usage) for more details.
|
|
68
|
+
|
|
69
|
+
```python
|
|
70
|
+
from synology_api.filestation import FileStation
|
|
71
|
+
from synology_api.downloadstation import DownloadStation
|
|
72
|
+
|
|
73
|
+
fs = FileStation(
|
|
74
|
+
'Synology Ip',
|
|
75
|
+
'Synology Port',
|
|
76
|
+
'Username',
|
|
77
|
+
'Password',
|
|
78
|
+
secure=False,
|
|
79
|
+
cert_verify=False,
|
|
80
|
+
dsm_version=7,
|
|
81
|
+
debug=True,
|
|
82
|
+
otp_code=None
|
|
83
|
+
)
|
|
84
|
+
|
|
85
|
+
ds = DownloadStation(
|
|
86
|
+
'Synology Ip',
|
|
87
|
+
'Synology Port',
|
|
88
|
+
'Username',
|
|
89
|
+
'Password',
|
|
90
|
+
secure=False,
|
|
91
|
+
cert_verify=False,
|
|
92
|
+
dsm_version=7,
|
|
93
|
+
debug=True,
|
|
94
|
+
otp_code=None
|
|
95
|
+
)
|
|
96
|
+
|
|
97
|
+
fs_info = fs.get_info()
|
|
98
|
+
ds_info = ds.get_info()
|
|
99
|
+
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
## Available Functions
|
|
103
|
+
|
|
104
|
+
At the moment there are around +300 APIs implemented with countless methods for each, the majority is not documented, but some are.
|
|
105
|
+
|
|
106
|
+
You can find a exhaustive list here:
|
|
107
|
+
[APIs - Supported APIs](https://n4s4.github.io/synology-api/docs/apis)
|
|
108
|
+
|
|
109
|
+
## Feeling kind?
|
|
110
|
+
If this code helps and you wish to support me:
|
|
111
|
+
- [Paypal](https://paypal.me/ren4s4)
|
|
112
|
+
- [GitHub Sponsor](https://github.com/sponsors/N4S4)
|
|
113
|
+
|
|
114
|
+
## Community
|
|
115
|
+
- [Telegram Group](https://t.me/SynologyApi)
|
|
116
|
+
- [Github Discussions](https://github.com/N4S4/synology-api/discussions)
|
|
117
|
+
|
|
118
|
+
## See Related projects
|
|
119
|
+
|
|
120
|
+
- [Synology API Telegram Bot](https://github.com/N4S4/synology-api-telegram-bot)
|
|
121
|
+
|
|
122
|
+
If you want to show your project in this section, write me.
|
|
123
|
+
|
|
124
|
+
## Bugs
|
|
125
|
+
|
|
126
|
+
Maybe?
|
|
127
|
+
|
|
128
|
+
I hate bugs..
|
|
129
|
+
|
|
130
|
+
Well report them please (if you'll ever use this code)
|
|
131
|
+
|
|
132
|
+
## Conclusions
|
|
133
|
+
|
|
134
|
+
There is still a lot to implement.
|
|
135
|
+
|
|
136
|
+
The code is probably in some parts twisted, I will try to optimize it at best.
|
|
137
|
+
|
|
138
|
+
## Contributing
|
|
139
|
+
|
|
140
|
+
Just Don't Be Scared.
|
|
141
|
+
Check [Contribute - Contribution 101](https://n4s4.github.io/synology-api/docs/contribute) for useful information.
|
|
142
|
+
|
|
143
|
+
## Author
|
|
144
|
+
|
|
145
|
+
- Renato Visaggio - _Initial_ _Work_ - [N4S4](https://github.com/N4S4)
|
|
146
|
+
|
|
147
|
+
## Contributors
|
|
148
|
+
|
|
149
|
+
- List of contributors here: [Contributors](https://github.com/N4S4/synology-api/graphs/contributors)
|
|
150
|
+
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
|
|
2
|
+

|
|
3
|
+
<img alt="Pepy Total Downloads" src="https://img.shields.io/pepy/dt/synology-api?color=blue">
|
|
4
|
+
<img alt="Website" src="https://img.shields.io/website?url=https%3A%2F%2Fn4s4.github.io%2Fsynology-api&label=docs&color=green">
|
|
5
|
+
|
|
6
|
+
<img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/n4s4/synology-api">
|
|
7
|
+
<img alt="GitHub License" src="https://img.shields.io/github/license/n4s4/synology-api">
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
# Synology Wrapper
|
|
11
|
+
|
|
12
|
+
If you find yourself here, most probably you are trying to develop something for your NAS, this wrapper might come to your help to build your script.
|
|
13
|
+
|
|
14
|
+
I would like to specify that I do this for hobby as is my passion and in my little free time.
|
|
15
|
+
|
|
16
|
+
Said this, there is no warranties chained and this library is provided "As Is", you will find many things can be simplified, and I slowly will but feel free to [Contribute](https://n4s4.github.io/synology-api/docs/contribute).
|
|
17
|
+
|
|
18
|
+
## Premise
|
|
19
|
+
|
|
20
|
+
I've tried this wrapper only with `python3`.
|
|
21
|
+
I do not know if it actually runs with previous versions
|
|
22
|
+
|
|
23
|
+
Before opening an issue make sure you do your own research, if you are not sure, write me.
|
|
24
|
+
|
|
25
|
+
## Installation
|
|
26
|
+
|
|
27
|
+
The package is distributed via pip3, but it can also be installed from source.
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
pip3 install synology-api
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
or
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
pip3 install git+https://github.com/N4S4/synology-api
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
## Basic Usage
|
|
41
|
+
Here is a basic example on how to use the package, check [Getting Started - Basic Usage](https://n4s4.github.io/synology-api/docs/getting-started/usage) for more details.
|
|
42
|
+
|
|
43
|
+
```python
|
|
44
|
+
from synology_api.filestation import FileStation
|
|
45
|
+
from synology_api.downloadstation import DownloadStation
|
|
46
|
+
|
|
47
|
+
fs = FileStation(
|
|
48
|
+
'Synology Ip',
|
|
49
|
+
'Synology Port',
|
|
50
|
+
'Username',
|
|
51
|
+
'Password',
|
|
52
|
+
secure=False,
|
|
53
|
+
cert_verify=False,
|
|
54
|
+
dsm_version=7,
|
|
55
|
+
debug=True,
|
|
56
|
+
otp_code=None
|
|
57
|
+
)
|
|
58
|
+
|
|
59
|
+
ds = DownloadStation(
|
|
60
|
+
'Synology Ip',
|
|
61
|
+
'Synology Port',
|
|
62
|
+
'Username',
|
|
63
|
+
'Password',
|
|
64
|
+
secure=False,
|
|
65
|
+
cert_verify=False,
|
|
66
|
+
dsm_version=7,
|
|
67
|
+
debug=True,
|
|
68
|
+
otp_code=None
|
|
69
|
+
)
|
|
70
|
+
|
|
71
|
+
fs_info = fs.get_info()
|
|
72
|
+
ds_info = ds.get_info()
|
|
73
|
+
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## Available Functions
|
|
77
|
+
|
|
78
|
+
At the moment there are around +300 APIs implemented with countless methods for each, the majority is not documented, but some are.
|
|
79
|
+
|
|
80
|
+
You can find a exhaustive list here:
|
|
81
|
+
[APIs - Supported APIs](https://n4s4.github.io/synology-api/docs/apis)
|
|
82
|
+
|
|
83
|
+
## Feeling kind?
|
|
84
|
+
If this code helps and you wish to support me:
|
|
85
|
+
- [Paypal](https://paypal.me/ren4s4)
|
|
86
|
+
- [GitHub Sponsor](https://github.com/sponsors/N4S4)
|
|
87
|
+
|
|
88
|
+
## Community
|
|
89
|
+
- [Telegram Group](https://t.me/SynologyApi)
|
|
90
|
+
- [Github Discussions](https://github.com/N4S4/synology-api/discussions)
|
|
91
|
+
|
|
92
|
+
## See Related projects
|
|
93
|
+
|
|
94
|
+
- [Synology API Telegram Bot](https://github.com/N4S4/synology-api-telegram-bot)
|
|
95
|
+
|
|
96
|
+
If you want to show your project in this section, write me.
|
|
97
|
+
|
|
98
|
+
## Bugs
|
|
99
|
+
|
|
100
|
+
Maybe?
|
|
101
|
+
|
|
102
|
+
I hate bugs..
|
|
103
|
+
|
|
104
|
+
Well report them please (if you'll ever use this code)
|
|
105
|
+
|
|
106
|
+
## Conclusions
|
|
107
|
+
|
|
108
|
+
There is still a lot to implement.
|
|
109
|
+
|
|
110
|
+
The code is probably in some parts twisted, I will try to optimize it at best.
|
|
111
|
+
|
|
112
|
+
## Contributing
|
|
113
|
+
|
|
114
|
+
Just Don't Be Scared.
|
|
115
|
+
Check [Contribute - Contribution 101](https://n4s4.github.io/synology-api/docs/contribute) for useful information.
|
|
116
|
+
|
|
117
|
+
## Author
|
|
118
|
+
|
|
119
|
+
- Renato Visaggio - _Initial_ _Work_ - [N4S4](https://github.com/N4S4)
|
|
120
|
+
|
|
121
|
+
## Contributors
|
|
122
|
+
|
|
123
|
+
- List of contributors here: [Contributors](https://github.com/N4S4/synology-api/graphs/contributors)
|
|
124
|
+
|
|
@@ -8,13 +8,13 @@ with open(path.join(this_directory, 'README.md'), encoding='utf-8') as f:
|
|
|
8
8
|
|
|
9
9
|
setup(
|
|
10
10
|
name='synology-api',
|
|
11
|
-
version='0.
|
|
11
|
+
version='0.8',
|
|
12
12
|
packages=find_packages(exclude=['tests*']),
|
|
13
13
|
license='MIT',
|
|
14
14
|
description='Python Synology API Wrapper',
|
|
15
15
|
long_description=long_description,
|
|
16
16
|
long_description_content_type='text/markdown',
|
|
17
|
-
install_requires=['requests', 'urllib3', 'setuptools'],
|
|
17
|
+
install_requires=['requests', 'urllib3', 'setuptools', 'requests_toolbelt', 'tqdm', 'cryptography', 'treelib'],
|
|
18
18
|
url='https://github.com/N4S4/synology-api',
|
|
19
19
|
author='Renato Visaggio',
|
|
20
20
|
author_email='synology.python.api@gmail.com'
|
|
@@ -5,10 +5,15 @@ from . import \
|
|
|
5
5
|
directory_server, \
|
|
6
6
|
docker_api, \
|
|
7
7
|
drive_admin_console, \
|
|
8
|
+
cloud_sync, \
|
|
8
9
|
core_active_backup, \
|
|
9
10
|
core_backup, \
|
|
10
11
|
core_certificate, \
|
|
11
12
|
core_sys_info, \
|
|
13
|
+
core_group, \
|
|
14
|
+
core_user, \
|
|
15
|
+
core_share, \
|
|
16
|
+
core_package, \
|
|
12
17
|
downloadstation, \
|
|
13
18
|
log_center, \
|
|
14
19
|
vpn, \
|
|
@@ -22,4 +27,4 @@ from . import \
|
|
|
22
27
|
virtualization, \
|
|
23
28
|
universal_search, \
|
|
24
29
|
snapshot, \
|
|
25
|
-
surveillancestation
|
|
30
|
+
surveillancestation
|