Skip to content

Commit 9cbadd2

Browse files
authored
fix: update readme.
1 parent 7df1c3f commit 9cbadd2

File tree

1 file changed

+4
-20
lines changed

1 file changed

+4
-20
lines changed

README.md

Lines changed: 4 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# UpCloud's Python API Client
44
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.
55

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

88
## Installation
99

@@ -43,25 +43,12 @@ python setup.py install
4343
* python 3.9
4444
* pypi3
4545

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-
5746
**Changelog:**
5847
* See the [Releases page](https://github.com/UpCloudLtd/upcloud-python-api/releases)
5948

60-
61-
6249
## Examples
6350

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.
6552
You must take this into account in your automations.
6653

6754
### Defining and creating Servers
@@ -134,7 +121,7 @@ for server in cluster:
134121

135122
```
136123

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.
138125
The syntax/attributes are exactly like above and under the hood they are converted to Server and Storage classes.
139126
This feature is mainly for easier usage of the module from Ansible, but may provide useful elsewhere.
140127

@@ -153,7 +140,7 @@ for server in cluster:
153140

154141
```
155142

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()
157144
depend on the Server's `state`, new helpers have been added. The helpers may be called regardless of
158145
the server's current state.
159146

@@ -201,9 +188,6 @@ manager.create_server(clone)
201188
```
202189

203190
### Easy access to servers and their information:
204-
205-
New in 0.3.0.
206-
207191
```python
208192

209193
# returns a public IPv4 (preferred) IPv6 (no public IPv4 was attached) address

0 commit comments

Comments
 (0)