Merge pull request #12 from UpCloudLtd/0.3.2-devel

0.3.2 devel

Author: Elias Nygren

.gitignore

@@ -9,3 +9,7 @@ dist/
 *.sublime-workspace
 docs/html/
 .tox
+
+# pyenv
+.python-version
+

README.md

@@ -9,15 +9,15 @@ NOTE: This Python client is still evolving. Please test all of your use cases th
 pip install upcloud-api
 ```
 
-Alternatively, if you want the newest master or a devel branch - clone the project and run:  
+Alternatively, if you want the newest master or a devel branch - clone the project and run:
 ```
 python setup.py install
 ```
 
 **!! SSL security update for python 2 !!**
 * short story: `pip install requests[security]` should solve all of your problems.
 * long story:
-	* upcloud-python-api uses [requests](http://docs.python-requests.org/en/latest/) 
+	* upcloud-python-api uses [requests](http://docs.python-requests.org/en/latest/)
 	  for HTTP(S) that in turn uses [urllib3](https://urllib3.readthedocs.org/en/latest/)
 	* urllib3 may detect that your python2.x's SSL is lacking as described
 	  [here](https://urllib3.readthedocs.org/en/latest/security.html#insecureplatformwarning) and
@@ -71,54 +71,59 @@ You must take this into account in your automations.
 ### Defining and creating Servers
 
 ```python
-import upcloud
-from upcloud import Server, Storage, ZONE
 
-manager = upcloud.CloudManager("api_user", "password")
+import upcloud_api
+from upcloud_api import Server, Storage, ZONE
+
+manager = upcloud_api.CloudManager('api_user', 'password')
 manager.authenticate() # test credentials
 
 cluster = {
-	"web1": Server( core_number = 1, # CPU cores
-					memory_amount = 512, # RAM in MB
-					hostname = "web1.example.com",
-					zone = ZONE.London, # ZONE.Helsinki and ZONE.Chicago available also
-					storage_devices = [
-				        # OS: Ubuntu 14.04 from template
-				        # default tier: maxIOPS, the 100k IOPS storage backend
-						Storage(os = "Ubuntu 14.04", size=10),
-						# secondary storage, hdd for reduced cost
-						Storage(size=100, tier="hdd")
-					]),
-
-	"web2": Server( core_number = 1,
-					memory_amount = 512,
-					hostname = "web2.example.com",
-					zone = ZONE.London,
-					storage_devices = [
-						Storage(os = "Ubuntu 14.04", size=10),
-						Storage(size=100, tier="hdd"),
-					]),
-
-	"db":	Server( core_number = 2,
-					memory_amount = 2048,
-					hostname = "db.example.com",
-					zone = ZONE.London,
-					storage_devices = [
-						Storage(os = "Ubuntu 14.04", size=10),
-						Storage(size=100),
-					]),
-
-	"lb":	Server( core_number = 2,
-					memory_amount = 1024,
-					hostname = "balancer.example.com",
-					zone = ZONE.London,
-					storage_devices = [
-						Storage(os = "Ubuntu 14.04", size=10)
-					])
+    'web1': Server(
+        core_number = 1, # CPU cores
+        memory_amount = 512, # RAM in MB
+        hostname = 'web1.example.com',
+        zone = ZONE.London, # ZONE.Helsinki and ZONE.Chicago available also
+        storage_devices = [
+            # OS: Ubuntu 14.04 from template
+            # default tier: maxIOPS, the 100k IOPS storage backend
+            Storage(os = 'Ubuntu 14.04', size = 10),
+            # secondary storage, hdd for reduced cost
+            Storage(size = 100, tier = 'hdd')
+        ]
+    ),
+    'web2': Server(
+        core_number = 1,
+        memory_amount = 512,
+        hostname = 'web2.example.com',
+        zone = ZONE.London,
+        storage_devices = [
+            Storage(os = 'Ubuntu 14.04', size = 10),
+            Storage(size = 100, tier = 'hdd'),
+        ]
+    ),
+    'db': Server(
+        plan = '2xCPU-2GB' # use a preconfigured plan, instead of custom
+        hostname = 'db.example.com',
+        zone = ZONE.London,
+        storage_devices = [
+            Storage(os = 'Ubuntu 14.04', size = 10),
+            Storage(size = 100),
+        ]
+    ),
+    'lb': Server(
+        core_number = 2,
+        memory_amount = 1024,
+        hostname = 'balancer.example.com',
+        zone = ZONE.London,
+        storage_devices = [
+            Storage(os = 'Ubuntu 14.04', size = 10)
+        ]
+    )
 }
 
 for server in cluster:
-  manager.create_server( cluster[server] ) # automatically populates the Server objects with data from API
+  manager.create_server(cluster[server]) # automatically populates the Server objects with data from API
 
 ```
 
@@ -141,7 +146,7 @@ for server in cluster:
 
 ```
 
-New in 0.3.0: as the success of server.start() or server.destroy() and storage.destroy() 
+New in 0.3.0: as the success of server.start() or server.destroy() and storage.destroy()
 depend on the Server's `state`, new helpers have been added. The helpers may be called regardless of
 the server's current state.
 

docs/CloudManager.md

@@ -13,7 +13,7 @@ manager.get_account()
 
 # Zone
 
-Zones are already hardcoded as Enums in `upcloud.ZONE`. However, they can be queried from the API too.
+Zones are already hardcoded as Enums in `upcloud_api.ZONE`. However, they can be queried from the API too.
 
 ```python
 
@@ -47,4 +47,4 @@ List the possible server CPU-ram configurations.
 
 manager.get_server_sizes
 
-```
+```

docs/Firewall.md

@@ -1,10 +1,10 @@
 The code examples use the following:
 
 ```python
-import upcloud
-from upcloud import FirewallRule
+import upcloud_api
+from upcloud_api import FirewallRule
 
-manager = upcloud.CloudManager("username", "password")
+manager = upcloud_api.CloudManager("username", "password")
 ```
 
 # About

docs/Server.md

@@ -1,18 +1,18 @@
 The examples use the following:
 ```python
-import upcloud
-from upcloud import Server
-from upcloud import Storage
-from upcloud import ZONE
+import upcloud_api
+from upcloud_api import Server
+from upcloud_api import Storage
+from upcloud_api import ZONE
 
-manager = upcloud.CloudManager("username", "password")
+manager = upcloud_api.CloudManager("username", "password")
 ```
 
 # Start / Stop / Restart
 
 ```python
 
-server.stop() 		
+server.stop()
 server.start()
 server.restart()
 
@@ -24,7 +24,7 @@ server.populate()
 Please note that the server might not be stopped/started/restarted immediately when the API responds. The `.populate()` method updates the object's fields from the API and is thus useful for checking `server.state`.
 
 ```
-Server states: 
+Server states:
 	"started","stopped" -- server is shut down or running
 	"maintenance" 		-- when shutting down or (re)starting
 	"error" 			-- erronous state in UpCloud's backend
@@ -50,10 +50,10 @@ Creation of servers in the API is handled by the CloudManager. It accepts a Serv
 ```python
 
 server = Server(
-			core_number = 1, 
-			memory_amount = 512, 
-			hostname = "web1.example.com", 
-			zone = ZONE.London, 
+			core_number = 1,
+			memory_amount = 512,
+			hostname = "web1.example.com",
+			zone = ZONE.London,
 			storage_devices = [
 				Storage(os = "Ubuntu 14.04", size=10),
 				Storage(size=10, tier="hdd")
@@ -66,11 +66,11 @@ manager.create_server( server )
 Currently available Storage operating systems are the following UpCloud public templates:
 
 ```python
-# upcloud/tools.py
+# upcloud_api/tools.py
 
 Operating Systems:
-	"CentOS 6.5", "CentOS 7.0", 
-	"Debian 7.8", "Ubuntu 12.04", "Ubuntu 14.04", 
+	"CentOS 6.5", "CentOS 7.0",
+	"Debian 7.8", "Ubuntu 12.04", "Ubuntu 14.04",
 	"Windows 2003", "Windows 2008", "Windows 2012"
 
 ```
@@ -93,11 +93,11 @@ server.save()
 
 ```
 
-The following fields of Server instance may be updated, all other fields are read-only. Trying to assign values to other fields leads to an error.  
-	
+The following fields of Server instance may be updated, all other fields are read-only. Trying to assign values to other fields leads to an error.
+
 ```python
-Updateable attributes: 
-	"boot_order", "core_number", "firewall", "hostname", "memory_amount",  
+Updateable attributes:
+	"boot_order", "core_number", "firewall", "hostname", "memory_amount",
 	"nic_model", "title", "timezone", "video_model", "vnc", "vnc_password"
 ```
 
@@ -141,4 +141,4 @@ Destroys the Server instance and its IP-addresses. However, does not destroy the
 
 server.destroy()
 
-```
+```

docs/Storage.md

@@ -1,11 +1,11 @@
 The code examples use the following:
 
 ```python
-import upcloud
-from upcloud import Storage
-from upcloud import ZONE
+import upcloud_api
+from upcloud_api import Storage
+from upcloud_api import ZONE
 
-manager = upcloud.CloudManager("username", "password")
+manager = upcloud_api.CloudManager("username", "password")
 ```
 
 # About
@@ -40,7 +40,7 @@ manager.get_storage(storage.uuid)
 `get_storages()` accepts one of the following parameters to filter the query:
 ```
 Storages list filters:
-	"normal" (default), "public", "private", 
+	"normal" (default), "public", "private",
 	"backup", "cdrom", "template", "favorite"
 ```
 
@@ -51,9 +51,9 @@ Storage can be created with the CloudManager's `.create_storage(size=10, tier="m
 
 ```python
 
-storage1 = manager.create_storage(	size=10, 
-									tier="maxiops", 
-									title="my storage disk", 
+storage1 = manager.create_storage(	size=10,
+									tier="maxiops",
+									title="my storage disk",
 									zone=ZONE.Helsinki )
 
 storage2 = manager.create_storage(100, zone=ZONE.Helsinki)
@@ -63,7 +63,7 @@ storage2 = manager.create_storage(100, zone=ZONE.Helsinki)
 
 ## Update
 
-Only the size and title of a storage can be updated. Please note that size can not be reduced and that OS level actions are required to account for the increased size. 
+Only the size and title of a storage can be updated. Please note that size can not be reduced and that OS level actions are required to account for the increased size.
 
 ```python
 
@@ -80,4 +80,4 @@ Warning: data loss is permanent.
 
 storage.destroy()
 
-```
+```

docs/index.md

@@ -13,10 +13,10 @@ The documentation is divided into two parts. Usage describes the basic CRUD func
 The code examples use the following:
 
 ```python
-import upcloud
-from upcloud import Storage
-from upcloud import Server
-from upcloud import ZONE
+import upcloud_api
+from upcloud_api import Storage
+from upcloud_api import Server
+from upcloud_api import ZONE
 
-manager = upcloud.CloudManager("username", "password")
+manager = upcloud_api.CloudManager("username", "password")
 ```

setup.py

@@ -4,15 +4,15 @@
 
 setup(
     name='upcloud-api',
-    version='0.3.1',
+    version='0.3.2',
     description='UpCloud API Client',
     author='Elias Nygren',
     author_email='elias.nygren@upcloud.com',
     maintainer='Elias Nygren',
     maintainer_email='elias.nygren@upcloud.com',
     url='https://github.com/UpCloudLtd/upcloud-python-api',
     packages=['upcloud_api', 'upcloud_api.cloud_manager'],
-    download='https://github.com/UpCloudLtd/upcloud-python-api/tarball/v0.3.1',
+    download='https://github.com/UpCloudLtd/upcloud-python-api/tarball/v0.3.2',
     license='MIT',
     install_requires=[
     	'future==0.14.3',

test/json_data/server.json

@@ -3,6 +3,7 @@
 		"server" : [
 			{
 				"zone" : "fi-hel1",
+				"plan": "custom",
 				"core_number" : "0",
 				"title" : "Helsinki server",
 				"hostname" : "fi.example.com",
@@ -17,6 +18,7 @@
 			},
 			{
 				"zone" : "uk-lon1",
+				"plan": "custom",
 				"core_number" : "0",
 				"title" : "London server",
 				"hostname" : "uk.example.com",

test/json_data/server_00798b85-efdc-41ca-8021-f6ef457b8531.json

@@ -45,6 +45,7 @@
 		"vnc_host" : "fi-he1l.vnc.upcloud.com",
 		"vnc_password" : "aabbccdd",
 		"vnc_port" : "00000",
-		"zone" : "fi-hel1"
+		"zone" : "fi-hel1",
+		"plan": "custom"
 	}
 }