Rework Usage Documentation

Author: LKaemmerling

docs/usage.rst

@@ -7,22 +7,24 @@ To use Hetzner Cloud Python in a project(Procedural style)::
     from hcloud import HcloudClient
 
     # Create a client
+    from hcloud.images.domain import Image
     from hcloud.servers.domain import Server
+    from hcloud.server_types.domain import ServerType
     from hcloud.volumes.domain import Volume
 
     client = HcloudClient(token="project-token")
 
     # Create 2 servers
     response1 = client.servers.create(
-        "Server1",
-        "cx11",
-        4711
+        name="Server1",
+        server_type=ServerType(name="cx11"),
+        image=Image(id=4711)
     )
 
     response2 = client.servers.create(
         "Server2",
-        "cx11",
-        4711
+        server_type=ServerType(name="cx11"),
+        image=Image(id=4711)
     )
 
     server1 = response1.server
@@ -38,12 +40,14 @@ To use Hetzner Cloud Python in a project(Procedural style)::
     # Create 2 volumes
 
     response1 = client.volumes.create(
-        30,
-        "Volume1"
+        size=15,
+        name="Volume1",
+        location=server1.location
     )
     response2 = client.volumes.create(
-        10,
-        "Volume2"
+        size=10,
+        name="Volume2",
+        location=server2.location
     )
 
     volume1 = response1.volume
@@ -65,8 +69,8 @@ To use Hetzner Cloud Python in a project(Procedural style)::
 
     server33 = Server(id=33)
     response = client.volumes.create(
-        33,
-        "Volume33",
+        size=33,
+        name="Volume33",
         server=server33
     )
 
@@ -75,17 +79,18 @@ To use Hetzner Cloud Python in a project(Procedural style)::
 
     # Create one more server and attach 2 volumes to it
     client.servers.create(
-        "Server2",
-        "cx11",
-        4711,
+        "Server3",
+        server_type=ServerType(name="cx11"),
+        image=Image(id=4711),
         volumes=[Volume(id=221), Volume(id=222)]
     )
 
 
 To use Hetzner Cloud Python in a project(OO style)::
 
     from hcloud import HcloudClient
-
+    from hcloud.images.domain import Image
+    from hcloud.server_types.domain import ServerType
 
     # Create a client
     client = HcloudClient(token="project-token")
@@ -94,31 +99,34 @@ To use Hetzner Cloud Python in a project(OO style)::
     # Create 2 servers
     response1 = client.servers.create(
         "Server1",
-        "cx11",
-        4711
+        server_type=ServerType(name="cx11"),
+        image=Image(id=4711)
     )
 
     response2 = client.servers.create(
         "Server2",
-        "cx11",
-        4711
+        server_type=ServerType(name="cx11"),
+        image=Image(id=4711)
     )
     # Get all servers
+    server1 = response1.server
+    server2 = response2.server
 
     servers = client.servers.get_all()
 
-    assert servers[0].id == response1.server.id
-    assert servers[1].id == response2.server.id
-
+    assert servers[0].id == server1.id
+    assert servers[1].id == server2.id
     # Create 2 volumes
 
     response1 = client.volumes.create(
-        30,
-        "Volume1"
+        size=15,
+        name="Volume1",
+        location=server1.location
     )
     response2 = client.volumes.create(
-        10,
-        "Volume2"
+        size=10,
+        name="Volume2",
+        location=server2.location
     )
 
     volume1 = response1.volume
@@ -135,3 +143,9 @@ To use Hetzner Cloud Python in a project(OO style)::
 
     # Poweroff 2nd server
     server2.power_off()
+
+    # Poweroff 2nd server
+    server2.power_off()
+
+
+More samples are in the repository: https://github.com/hetznercloud/hcloud-python/tree/master/examples.

examples/usage_oop.py

@@ -0,0 +1,55 @@
+from hcloud import HcloudClient
+from hcloud.images.domain import Image
+from hcloud.server_types.domain import ServerType
+
+# Create a client
+client = HcloudClient(token="project-token")
+
+# Create 2 servers
+# Create 2 servers
+response1 = client.servers.create(
+    "Server1",
+    server_type=ServerType(name="cx11"),
+    image=Image(id=4711)
+)
+
+response2 = client.servers.create(
+    "Server2",
+    server_type=ServerType(name="cx11"),
+    image=Image(id=4711)
+)
+# Get all servers
+server1 = response1.server
+server2 = response2.server
+
+servers = client.servers.get_all()
+
+assert servers[0].id == server1.id
+assert servers[1].id == server2.id
+# Create 2 volumes
+
+response1 = client.volumes.create(
+    size=15,
+    name="Volume1",
+    location=server1.location
+)
+response2 = client.volumes.create(
+    size=10,
+    name="Volume2",
+    location=server2.location
+)
+
+volume1 = response1.volume
+volume2 = response2.volume
+
+# Attach volume to server
+
+volume1.attach(server1)
+volume2.attach(server2)
+
+# Detach second volume
+
+volume2.detach()
+
+# Poweroff 2nd server
+server2.power_off()

examples/usage_procedurale.py

@@ -0,0 +1,78 @@
+from hcloud import HcloudClient
+
+from hcloud.images.domain import Image
+from hcloud.servers.domain import Server
+from hcloud.server_types.domain import ServerType
+from hcloud.volumes.domain import Volume
+
+client = HcloudClient(token="project-token")
+
+# Create 2 servers
+response1 = client.servers.create(
+    name="Server1",
+    server_type=ServerType(name="cx11"),
+    image=Image(id=4711)
+)
+
+response2 = client.servers.create(
+    "Server2",
+    server_type=ServerType(name="cx11"),
+    image=Image(id=4711)
+)
+
+server1 = response1.server
+server2 = response2.server
+
+# Get all servers
+
+servers = client.servers.get_all()
+
+assert servers[0].id == server1.id
+assert servers[1].id == server2.id
+
+# Create 2 volumes
+
+response1 = client.volumes.create(
+    size=15,
+    name="Volume1",
+    location=server1.location
+)
+response2 = client.volumes.create(
+    size=10,
+    name="Volume2",
+    location=server2.location
+)
+
+volume1 = response1.volume
+volume2 = response2.volume
+
+# Attach volume to server
+
+client.volumes.attach(server1, volume1)
+client.volumes.attach(server2, volume2)
+
+# Detach second volume
+
+client.volumes.detach(volume2)
+
+# Poweroff 2nd server
+client.servers.power_off(server2)
+
+# Create one more volume and attach it to server with id=33
+
+server33 = Server(id=33)
+response = client.volumes.create(
+    size=33,
+    name="Volume33",
+    server=server33
+)
+
+print(response.action.status)
+
+# Create one more server and attach 2 volumes to it
+client.servers.create(
+    "Server3",
+    server_type=ServerType(name="cx11"),
+    image=Image(id=4711),
+    volumes = [Volume(id=221), Volume(id=222)]
+)