diff --git a/corenetworks/client.py b/corenetworks/client.py index 0ae5ae0..29a223a 100644 --- a/corenetworks/client.py +++ b/corenetworks/client.py @@ -330,7 +330,7 @@ class CoreNetworks(): if isinstance(result, list): return [el for el in result] elif isinstance(result, dict): - return result + return [result] else: raise CorenetworksError("Unknown type: {}".format(type(result))) diff --git a/docs/content/setup/_index.md b/docs/content/setup/_index.md index 4fa7322..dbf64fb 100644 --- a/docs/content/setup/_index.md +++ b/docs/content/setup/_index.md @@ -3,3 +3,63 @@ title: Setup --- {{< toc >}} + +## Installation + +```python +pip install corenetworks +``` + +## Example usage + +```python +#!/usr/bin/env python + +import requests + +from corenetworks import CoreNetworks +from corenetworks.exceptions import CoreNetworksException + +try: + user = "my_user" + password = "my_password" + dns = CoreNetworks(user, password, auto_commit=True) + + zones = dns.zones() + print(zones) + # [{'name': 'example.com', 'type': 'master'}, {'name': 'test.com', 'type': 'master'}] + + zone = dns.zone(zone="example.com") + print(zone) + # [{'active': True, 'dnssec': True, 'master': None, 'name': 'example.com', 'tsig': None, 'type': 'master'}] + + records = dns.records(zone="example.com") + print(records) + # [{'name': '@', 'ttl': '1800', 'type': 'SOA', 'data': 'ns1.core-networks.de. [...]'}, {'name': 'test', 'ttl': '60', 'type': 'A', 'data': '1.2.3.4'}, {'name': '@', 'ttl': '86400', 'type': 'NS', 'data': 'ns1.core-networks.de.'}, {'name': '@', 'ttl': '86400', 'type': 'NS', 'data': 'ns2.core-networks.eu.'}, {'name': '@', 'ttl': '86400', 'type': 'NS', 'data': 'ns3.core-networks.com.'}] + + filtered = dns.records(zone="example.com", params={"type": ["A", "AAAA"]}) + print(filtered) + # [{'name': 'test', 'ttl': '3600', 'type': 'A', 'data': '1.2.3.4'}] + + add_record = dns.add_record( + zone="example.com", params={ + "name": "test", + "type": "A", + "data": "127.0.0.1", + "ttl": 3600, + } + ) + print(add_record) + # [{'name': 'test', 'ttl': '3600', 'type': 'A', 'data': '127.0.0.1'}] + + del_record = dns.delete_record(zone="example.com", params={ + "name": "test", + "type": "A", + }) + print(del_record) + # [] + +except Exception as e: + print(str(e)) + +```