Clean-up markdown a bit

Clean-up markdown files a bit. Get section headers right, use `python`
block marker (instead of `Python`), make sure example code is formatted
uniformly, and a couple of capitalization fixes.

Author: bkircher

CONTRIBUTING.md

@@ -16,6 +16,5 @@ GitHub project.
 
 ## Submitting Patches
 
-The gridscale_api_client_python source code is managed using the git distributed source control 
+The gridscale_api_client_python source code is managed using the git distributed source control
 management tool <https://www.git-scm.org/>. Please submit patches accordingly.
-

README.md

@@ -1,19 +1,24 @@
+# gridscale_api_client_python
+
 This the official Python wrapper for gridscale's [API](https://gridscale.io/en//api-documentation/index.html). Allowing you to manage your own infrastructure from your own applications.
 
-# Prerequisites
+## Prerequisites
 
 First, the Python programming language needs to be installed. This can be done by using the [official downloads](https://www.python.org/downloads/) page.
 
-Once done, download and install via [pypi](https://pypi.org)
+Once done, download and install via [PyPI](https://pypi.org)
+
+```shell
+$ pip3 install gs_api_client
+```
 
-`pip3 install gs_api_client`
+## Introduction
 
-# Introduction
 First, you will need your [API credentials](https://my.gridscale.io/Easy/APIs/).
 
 In the [examples.py](examples/examples.py) replace the `AUTH_TOKEN` & `USER_UUID` with your credentials.
 
-# Authentication
+## Authentication
 
 These imports and configs need to be setup before other commands can be run. If you do not need synchronous or asynchronous requests, you can leave out `SyncGridscaleApiClient` & `GridscaleApiClient` respectively.
 
@@ -22,72 +27,76 @@ from gs_api_client import Configuration
 from gs_api_client import SyncGridscaleApiClient, GridscaleApiClient
 
 # Initiate the configuration
-api_config = Configuration()
-api_config.api_key['X-Auth-Token'] = "AUTH_TOKEN"
-api_config.api_key['X-Auth-UserId'] = "USER_UUID"
+config = Configuration()
+config.api_key['X-Auth-Token'] = "AUTH_TOKEN"
+config.api_key['X-Auth-UserId'] = "USER_UUID"
 
 # Setup the client
-sync_api = SyncGridscaleApiClient(configuration=api_config)
-async_api = GridscaleApiClient(configuration=api_config)
+sync_api = SyncGridscaleApiClient(configuration=config)
+async_api = GridscaleApiClient(configuration=config)
 ```
 
-# Async vs Sync Clients
+## Async vs. sync client
 
-We provide two clients `SyncGridscaleApiClient` & `GridscaleApiClient`. gridscale's API performs long running operations asynchronously in the background while returning a 202 response code, with the request identifier in the `x-request-id` response header.
+We provide two clients `SyncGridscaleApiClient` and `GridscaleApiClient`. gridscale's API performs long running operations asynchronously in the background while returning a 202 response code, with the request identifier in the `x-request-id` response header.
 
 The main differences are:
+
 - `GridscaleApiClient` exposes bare gridscale API functionality, while `SyncGridscaleApiClient` adds a convenience layer on top.
 - `SyncGridscaleApiClient` determines whether the request is sync or async.
 - Makes asynchronous operations behave as if they were synchronous:
   - The client will block until the request has finished, successful or not.
   - Throws an `AsynchronousApiError` exception, in the case of failure.
 - With most `PATCH` and `POST` requests, the synchronous client will return the resulting object instead of an empty body or just the reference.
 
-# Debugging
+## Debugging
 
 Adding this line below, will output further information for debugging
 
-```Python
-api_config.debug = True
+```python
+config.debug = True
 ```
 
-# Access response header
+## Access response header
 
 Adding `http_info=True` when instantiating the client, return value will be a tuple of response, response code and response headers (dict).
 
-```Python
+```python
 sync_api = SyncGridscaleApiClient(http_info=True)
 async_api = GridscaleApiClient(http_info=True)
 ```
 
-# Basic request examples
-    from pprint import pprint
+## Basic request examples
+
+```python
+from pprint import pprint
 
-    # Get all Servers
-    pprint(async_api.get_servers())
+# Get all servers
+pprint(async_api.get_servers())
 
-    # Create a Server
-    pprint(async_api.create_server({'name':'test', 'cores': 1, 'memory': 2}))
+# Create a server
+pprint(async_api.create_server({'name':'test', 'cores': 1, 'memory': 2}))
 
-    # Update a Server
-    pprint(async_api.update_server('<UUID>', {
-        'name':'windows production Server',
-        'cores': 2,
-        'memory': 4
-        }))
+# Update a server
+pprint(async_api.update_server('<UUID>', {
+    'name':'windows production Server',
+    'cores': 2,
+    'memory': 4
+    }))
 
-    # Delete a Server
-    pprint(client.delete_storage('<UUID>'))
+# Delete a server
+pprint(client.delete_storage('<UUID>'))
+```
 
-# Exhaustive list of all functions
+## Exhaustive list of all functions
 
 Inside the [examples.py](examples/examples.py) file, you can see some example requests to get your started. All endpoints are fully documented in our [API](https://gridscale.io/en//api-documentation/index.html)
 
-## Requests
+### Requests
 
 - get_request
 
-## Locations
+### Locations
 
 - get_locations
 - get_location
@@ -99,7 +108,7 @@ Inside the [examples.py](examples/examples.py) file, you can see some example re
 - get_location_storages
 - get_location_templates
 
-## Servers
+### Servers
 
 - get_servers
 - get_server
@@ -113,7 +122,7 @@ Inside the [examples.py](examples/examples.py) file, you can see some example re
 - update_server_power
 - server_power_shutdown
 
-### Server Relations
+### Server relations
 
 - get_server_linked_ip
 - get_server_linked_ips
@@ -135,7 +144,7 @@ Inside the [examples.py](examples/examples.py) file, you can see some example re
 - unlink_network_from_server
 - unlink_storage_from_server
 
-## Storages
+### Storages
 
 - get_storages
 - get_storage
@@ -172,7 +181,7 @@ Inside the [examples.py](examples/examples.py) file, you can see some example re
 - get_template_events
 - get_deleted_templates
 
-### Marketplace Templates
+### Marketplace templates
 
 - get_marketplace_templates
 - get_marketplace_template
@@ -181,7 +190,7 @@ Inside the [examples.py](examples/examples.py) file, you can see some example re
 - delete_marketplace_template
 - get_marketplace_template_events
 
-## Networks
+### Networks
 
 - get_network
 - get_networks
@@ -191,7 +200,7 @@ Inside the [examples.py](examples/examples.py) file, you can see some example re
 - get_network_events
 - get_deleted_networks
 
-## IPs
+### IP addresses
 
 - get_ips
 - get_ip
@@ -201,7 +210,7 @@ Inside the [examples.py](examples/examples.py) file, you can see some example re
 - get_ip_events
 - get_deleted_ips
 
-## Load Balancers
+### Load balancers
 
 - get_loadbalancers
 - get_loadbalancer
@@ -211,7 +220,7 @@ Inside the [examples.py](examples/examples.py) file, you can see some example re
 - get_loadbalancer_events
 - get_deleted_loadbalancers
 
-## PaaS
+### PaaS
 
 - get_paas_services
 - get_paas_service
@@ -228,7 +237,7 @@ Inside the [examples.py](examples/examples.py) file, you can see some example re
 - get_paas_service_templates
 - get_deleted_paas_services
 
-## Firewalls
+### Firewalls
 
 - get_firewalls
 - get_firewall
@@ -237,7 +246,7 @@ Inside the [examples.py](examples/examples.py) file, you can see some example re
 - delete_firewall
 - get_firewall_events
 
-## Iso Images
+### ISO images
 
 - get_isoimages
 - get_isoimage
@@ -247,12 +256,12 @@ Inside the [examples.py](examples/examples.py) file, you can see some example re
 - get_isoimage_events
 - get_deleted_isoimages
 
-## Labels
+### Labels
 
 - get_labels
 - get_label
 
-## SSH Keys
+### SSH keys
 
 - get_ssh_keys
 - get_ssh_key
@@ -261,11 +270,11 @@ Inside the [examples.py](examples/examples.py) file, you can see some example re
 - delete_ssh_key
 - get_ssh_key_events
 
-## Events
+### Events
 
 - event_get_all
 
-## Object Storage
+### Object storage
 
 - get_buckets
 - get_access_keys