|
1 | 1 | # save-and-restore-api |
2 | 2 |
|
3 | | -Python package for communicating with Save-and-Restore service (CSS Phoebus). The |
4 | | -package provides syncronous (thread-based) and asynchronous (asyncio) versions of |
5 | | -the API functions. |
| 3 | +The repository contains a Python package for communicating with Save-and-Restore service |
| 4 | +(CSS Phoebus). The package provides syncronous (thread-based) and asynchronous (asyncio) |
| 5 | +versions of the API functions. |
6 | 6 |
|
7 | 7 | ## Examples |
8 | 8 |
|
9 | 9 | The following code creates a folder node named "My Folder" under the root node: |
10 | 10 |
|
11 | 11 | ```python |
12 | 12 |
|
13 | | - from save_and_restore_api import SaveRestoreAPI |
| 13 | +from save_and_restore_api import SaveRestoreAPI |
14 | 14 |
|
15 | | - with SaveRestoreAPI(base_url="http://localhost:8080/save-restore") as SR: |
16 | | - SR.auth_set(username="user", password="user_password") |
| 15 | +with SaveRestoreAPI(base_url="http://localhost:8080/save-restore") as SR: |
| 16 | + SR.auth_set(username="user", password="user_password") |
17 | 17 |
|
18 | | - root_folder_uid = SR.ROOT_NODE_UID |
19 | | - node={"name": "My Folder", "nodeType": "FOLDER"} |
| 18 | + root_folder_uid = SR.ROOT_NODE_UID |
| 19 | + node={"name": "My Folder", "nodeType": "FOLDER"} |
20 | 20 |
|
21 | | - folder = SR.node_add(root_folder_uid, node=node) |
| 21 | + folder = SR.node_add(root_folder_uid, node=node) |
22 | 22 |
|
23 | | - print(f"Created folder metadata: {folder}") |
| 23 | + print(f"Created folder metadata: {folder}") |
24 | 24 | ``` |
25 | 25 |
|
26 | 26 | Async version of the same code: |
27 | 27 |
|
28 | 28 | ```python |
29 | 29 |
|
30 | | - from save_and_restore_api.aio import SaveRestoreAPI |
| 30 | +from save_and_restore_api.aio import SaveRestoreAPI |
31 | 31 |
|
32 | | - async with SaveRestoreAPI(base_url="http://localhost:8080/save-restore") as SR: |
33 | | - await SR.auth_set(username="user", password="user_password") |
| 32 | +async with SaveRestoreAPI(base_url="http://localhost:8080/save-restore") as SR: |
| 33 | + await SR.auth_set(username="user", password="user_password") |
34 | 34 |
|
35 | | - root_folder_uid = SR.ROOT_NODE_UID |
36 | | - node={"name": "My Folder", "nodeType": "FOLDER"} |
| 35 | + root_folder_uid = SR.ROOT_NODE_UID |
| 36 | + node={"name": "My Folder", "nodeType": "FOLDER"} |
37 | 37 |
|
38 | | - folder = await SR.node_add(root_folder_uid, node=node) |
39 | | - print(f"Created folder metadata: {folder}") |
| 38 | + folder = await SR.node_add(root_folder_uid, node=node) |
| 39 | + print(f"Created folder metadata: {folder}") |
40 | 40 | ``` |
41 | 41 |
|
42 | 42 |
|
|
0 commit comments