cacholong-cloud-cli 0.3.2__tar.gz → 0.3.3__tar.gz

{cacholong_cloud_cli-0.3.2 → cacholong_cloud_cli-0.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: cacholong-cloud-cli
-Version: 0.3.2
+Version: 0.3.3
 Summary: Cacholong CLI, manage cloud environments at Cacholong!
 Author: Matthijs Möhlmann
 Author-email: matthijs@cacholong.nl
@@ -39,18 +39,66 @@ ccloud accounts list
 
 This will give you an overview of accounts where you have access to.
 
-## Add your files
+## Usage
+
+Overview of the possibilities:
+```bash
+ccloud --help
+```
+
+To fetch an overview of the dns-zones for an account:
+```bash
+ccloud dns-zones list --account <account uuid>
+```
+
+Creating a DNS-record:
+```bash
+ccloud dns-records create --dns-zone <dns-zone uuid> \
+    --name localhost.example.com \
+    --dns-record-type A \
+    --content 127.0.0.1 \
+    --ttl 300
+```
+
+Updating a DNS-record:
+```bash
+ccloud dns-records update <dns-record uuid> \
+    --content 127.0.0.1
+```
+
+Deleting a DNS-record:
+```bash
+ccloud dns-records delete <dns-record uuid>
+```
+
+Every command includes an option --help which will give an overview of the possibilities.
+
+## Advanced usage
 
-## Integrate with your tools
+Its also possible to create your own command line utility to handle various parts. Here are the same examples as above but now using python.
 
-## Collaborate with your team
+### Fetching DNS-zones
+```python
+import asyncio
+
+from cacholong_sdk.connection import connection
+from cacholong_sdk import ResourceTuple, Inclusion, Filter
+from cacholong_sdk import DnsZone, DnsZoneModel, DnsRecord, DnsRecordModel
+
+async def main():
+    async with connection('https://api.cacholong.eu/api/v1/', 'YOUR-API-TOKEN') as api:
+        searchfilter = Filter(domain=sys.argv[1])
+        DnsZoneCtrl = DnsZone(api)
+        async for zone in DnsZoneCtrl.fetch_all(searchfilter):
+            print(zone["domain"])
+
+# Execute main function
+asyncio.run(main())
+```
 
 ## Suggestions for a good README
 Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
 
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
-
 ## Support
 Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
 

{cacholong_cloud_cli-0.3.2 → cacholong_cloud_cli-0.3.3}/README.md

@@ -17,18 +17,66 @@ ccloud accounts list
 
 This will give you an overview of accounts where you have access to.
 
-## Add your files
+## Usage
+
+Overview of the possibilities:
+```bash
+ccloud --help
+```
+
+To fetch an overview of the dns-zones for an account:
+```bash
+ccloud dns-zones list --account <account uuid>
+```
+
+Creating a DNS-record:
+```bash
+ccloud dns-records create --dns-zone <dns-zone uuid> \
+    --name localhost.example.com \
+    --dns-record-type A \
+    --content 127.0.0.1 \
+    --ttl 300
+```
+
+Updating a DNS-record:
+```bash
+ccloud dns-records update <dns-record uuid> \
+    --content 127.0.0.1
+```
+
+Deleting a DNS-record:
+```bash
+ccloud dns-records delete <dns-record uuid>
+```
+
+Every command includes an option --help which will give an overview of the possibilities.
+
+## Advanced usage
 
-## Integrate with your tools
+Its also possible to create your own command line utility to handle various parts. Here are the same examples as above but now using python.
 
-## Collaborate with your team
+### Fetching DNS-zones
+```python
+import asyncio
+
+from cacholong_sdk.connection import connection
+from cacholong_sdk import ResourceTuple, Inclusion, Filter
+from cacholong_sdk import DnsZone, DnsZoneModel, DnsRecord, DnsRecordModel
+
+async def main():
+    async with connection('https://api.cacholong.eu/api/v1/', 'YOUR-API-TOKEN') as api:
+        searchfilter = Filter(domain=sys.argv[1])
+        DnsZoneCtrl = DnsZone(api)
+        async for zone in DnsZoneCtrl.fetch_all(searchfilter):
+            print(zone["domain"])
+
+# Execute main function
+asyncio.run(main())
+```
 
 ## Suggestions for a good README
 Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
 
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
-
 ## Support
 Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
 

{cacholong_cloud_cli-0.3.2 → cacholong_cloud_cli-0.3.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cacholong-cloud-cli"
-version = "0.3.2"
+version = "0.3.3"
 description = "Cacholong CLI, manage cloud environments at Cacholong!"
 authors = ["Matthijs Möhlmann <matthijs@cacholong.nl>"]
 readme = "README.md"