You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-20Lines changed: 4 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
# UpCloud's Python API Client
4
4
OOP-based api client for [UpCloud's API](https://developers.upcloud.com/1.3/). Features most of the API's functionality and some convenience functions that combine several API endpoints and logic.
5
5
6
-
NOTE: This Python client is still evolving. Please test all of your use cases thoroughly before actual production use. Using a separate UpCloud account for testing / developing the client is recommended.
6
+
Please test all of your use cases thoroughly before actual production use. Using a separate UpCloud account for testing / developing the client is recommended.
7
7
8
8
## Installation
9
9
@@ -43,25 +43,12 @@ python setup.py install
43
43
* python 3.9
44
44
* pypi3
45
45
46
-
## Features
47
-
* OOP based management of Servers, Storages and IP-addresses with full CRUD.
48
-
* since 0.2: manage both IPv4 and IPv6 addresses
49
-
* since 0.1.1: can use custom storage templates in addition to public templates
50
-
* Clear way to define your infrastructure, emphasis on clear and easy syntax
51
-
* Access all the data of the objects ( e.g. ssh credentials )
52
-
* Scale horizontally by creating / destroying servers
53
-
* Scale vertically by changing the RAM, CPU, storage specs of any server
54
-
* Manage firewall (on/off and individual rules)
55
-
* since 0.2: full management of firewall rules
56
-
57
46
**Changelog:**
58
47
* See the [Releases page](https://github.com/UpCloudLtd/upcloud-python-api/releases)
59
48
60
-
61
-
62
49
## Examples
63
50
64
-
Note that some operations are not instant, for example a server is not fully shut down when the API responds.
51
+
Note that the API finishes the request before the server is shutdown. Poll the server details to monitor server status.
65
52
You must take this into account in your automations.
66
53
67
54
### Defining and creating Servers
@@ -134,7 +121,7 @@ for server in cluster:
134
121
135
122
```
136
123
137
-
New in 0.3.0: servers can now be defined as dicts without using Server or Storage classes.
124
+
Servers can be defined as dicts without using Server or Storage classes.
138
125
The syntax/attributes are exactly like above and under the hood they are converted to Server and Storage classes.
139
126
This feature is mainly for easier usage of the module from Ansible, but may provide useful elsewhere.
140
127
@@ -153,7 +140,7 @@ for server in cluster:
153
140
154
141
```
155
142
156
-
New in 0.3.0: as the success of server.start() or server.destroy() and storage.destroy()
143
+
As the success of server.start() or server.destroy() and storage.destroy()
157
144
depend on the Server's `state`, new helpers have been added. The helpers may be called regardless of
158
145
the server's current state.
159
146
@@ -201,9 +188,6 @@ manager.create_server(clone)
201
188
```
202
189
203
190
### Easy access to servers and their information:
204
-
205
-
New in 0.3.0.
206
-
207
191
```python
208
192
209
193
# returns a public IPv4 (preferred) IPv6 (no public IPv4 was attached) address
0 commit comments