Skip to content

Commit 419ea77

Browse files
committed
DOC: edited readme
1 parent 7d59423 commit 419ea77

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,42 @@
11
# save-and-restore-api
22

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.
66

77
## Examples
88

99
The following code creates a folder node named "My Folder" under the root node:
1010

1111
```python
1212

13-
from save_and_restore_api import SaveRestoreAPI
13+
from save_and_restore_api import SaveRestoreAPI
1414

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")
1717

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"}
2020

21-
folder = SR.node_add(root_folder_uid, node=node)
21+
folder = SR.node_add(root_folder_uid, node=node)
2222

23-
print(f"Created folder metadata: {folder}")
23+
print(f"Created folder metadata: {folder}")
2424
```
2525

2626
Async version of the same code:
2727

2828
```python
2929

30-
from save_and_restore_api.aio import SaveRestoreAPI
30+
from save_and_restore_api.aio import SaveRestoreAPI
3131

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")
3434

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"}
3737

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}")
4040
```
4141

4242

0 commit comments

Comments
 (0)