Rename Client & Let APIException return a string (#24)

Closes #23

Author: LKaemmerling

Makefile

@@ -68,7 +68,7 @@ coverage: ## check code coverage quickly with the default Python
 docs: ## generate Sphinx HTML documentation, including API docs
 	$(MAKE) -C docs clean
 	$(MAKE) -C docs html
-     $(BROWSER) docs/_build/html/index.html
+	$(BROWSER) docs/_build/html/index.html
 
 servedocs: docs ## compile the docs watching for changes
 	watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .

docs/api.rst

@@ -4,7 +4,7 @@ hcloud-python API
 Main Interface
 ---------------
 
-.. autoclass:: hcloud.HcloudClient
+.. autoclass:: hcloud.Client
     :members:
 
 

docs/index.rst

@@ -34,11 +34,11 @@ Create Server
 .. code-block:: python
    :linenos:
 
-   from hcloud import HcloudClient
+   from hcloud import Client
    from hcloud.server_types.domain import ServerType
    from hcloud.images.domain import Image
 
-   client = HcloudClient(token="{YOUR_API_TOKEN}")  # Please paste your API token here between the quotes
+   client = Client(token="{YOUR_API_TOKEN}")  # Please paste your API token here between the quotes
    response = client.servers.create(name="my-server", server_type=ServerType(name="cx11"), image=Image(name="ubuntu-18.04"))
    server = response.server
    print(server)
@@ -49,9 +49,9 @@ List Servers
 .. code-block:: python
    :linenos:
 
-   from hcloud import HcloudClient
+   from hcloud import Client
 
-   client = HcloudClient(token="{YOUR_API_TOKEN}")  # Please paste your API token here between the quotes
+   client = Client(token="{YOUR_API_TOKEN}")  # Please paste your API token here between the quotes
    servers = client.servers.get_all()
    print(servers)
 

docs/samples.rst

@@ -6,12 +6,12 @@ To use Hetzner Cloud Python in a project:
 
 .. code-block:: python
 
-    from hcloud import HcloudClient
+    from hcloud import Client
     from hcloud.images.domain import Image
     from hcloud.server_types.domain import ServerType
 
     # Create a client
-    client = HcloudClient(token="project-token")
+    client = Client(token="project-token")
 
     # Create 2 servers
     # Create 2 servers

examples/create_server.py

@@ -1,7 +1,7 @@
-from hcloud import HcloudClient
+from hcloud import Client
 from hcloud.images.domain import Image
 
-client = HcloudClient(token="{YOUR_API_TOKEN}")  # Please paste your API token here between the quotes
+client = Client(token="{YOUR_API_TOKEN}")  # Please paste your API token here between the quotes
 response = client.servers.create(name="my-server", server_type="cx11", image=Image(name="ubuntu-18.04"))
 server = response.server
 print(server)

examples/list_servers.py

@@ -1,5 +1,5 @@
-from hcloud import HcloudClient
+from hcloud import Client
 
-client = HcloudClient(token="{YOUR_API_TOKEN}")  # Please paste your API token here between the quotes
+client = Client(token="{YOUR_API_TOKEN}")  # Please paste your API token here between the quotes
 servers = client.servers.get_all()
 print(servers)

examples/usage_oop.py

@@ -1,9 +1,9 @@
-from hcloud import HcloudClient
+from hcloud import Client
 from hcloud.images.domain import Image
 from hcloud.server_types.domain import ServerType
 
 # Create a client
-client = HcloudClient(token="project-token")
+client = Client(token="project-token")
 
 # Create 2 servers
 # Create 2 servers

examples/usage_procedurale.py

@@ -1,11 +1,11 @@
-from hcloud import HcloudClient
+from hcloud import 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")
+client = Client(token="project-token")
 
 # Create 2 servers
 response1 = client.servers.create(

hcloud/__init__.py

@@ -1,3 +1,3 @@
 # -*- coding: utf-8 -*-
 
-from .hcloud import HcloudClient, APIException  # noqa
+from .hcloud import Client, APIException  # noqa

hcloud/core/client.py

@@ -8,7 +8,7 @@ class ClientEntityBase(object):
 
     def __init__(self, client):
         """
-        :param client: HcloudClient
+        :param client: Client
         :return self
         """
         self._client = client