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

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

@@ -1,10 +1,12 @@
 Metadata-Version: 2.3
 Name: cacholong-cloud-cli
-Version: 0.3.3
+Version: 0.3.4
 Summary: Cacholong CLI, manage cloud environments at Cacholong!
+License: MIT
 Author: Matthijs Möhlmann
 Author-email: matthijs@cacholong.nl
 Requires-Python: >=3.11,<4.0
+Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
@@ -28,6 +30,14 @@ The API client library for managing various resources.
 
 ## Getting started
 
+To install this package you need to take a few steps before this works correctly
+1. Create an virtual environment: python3 -m venv <directory>
+2. Activate the environment: <directory>/bin/activate
+3. Now install the package: pip install cacholong-cloud-cli
+4. Or upgrade the package: pip install cacholong-cloud-cli --upgrade
+
+Now you can use the command `ccloud` on the system. Please note, make sure to activate the virtual environment before running the command `ccloud`.
+
 You will need an API-token. This token can be created using our panel at https://cp.cacholong.eu/#/user/settings/api. You can create an api token within your profile under API.
 
 When running the command `ccloud` for the first time it will ask you for an API-token.
@@ -87,7 +97,7 @@ 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])
+        searchfilter = Filter(account="UUID_OF_ACCOUNT")
         DnsZoneCtrl = DnsZone(api)
         async for zone in DnsZoneCtrl.fetch_all(searchfilter):
             print(zone["domain"])
@@ -96,22 +106,69 @@ async def main():
 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.
+### Create a DNS-record
+```python
+import asyncio
 
-## 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.
+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:
+        DnsRecordCtrl = DnsRecord(api)
+
+        dns_record = DNSRecordCtrl.create()
+        dns_record["dns-zone"] = ResourceTuple("UUID_DNS_ZONE", "dns-zones")
+        dns_record["name"] = "localhost.example.nl"
+        dns_record["dns_record_type"] = "A"
+        dns_record["content"] = "127.0.0.1"
+        dns_record["ttl"] = 300
+        await DNSRecordCtrl.store(dns_record)
+
+# Execute main function
+asyncio.run(main())
+```
+
+### Update a DNS-record
+```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:
+        DnsRecordCtrl = DnsRecord(api)
+
+        dns_record = await DnsRecordCtrl.fetch("UUID_OF_DNS_RECORD")
+        dns_record["content"] = "127.0.0.1"
+
+        # Be careful: the above change will be applied automatically
+
+# Execute main function
+asyncio.run(main())
+```
+
+### Delete a DNS-record
+```python
+import asyncio
 
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
+from cacholong_sdk.connection import connection
+from cacholong_sdk import ResourceTuple, Inclusion, Filter
+from cacholong_sdk import DnsZone, DnsZoneModel, DnsRecord, DnsRecordModel
 
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
+async def main():
+    async with connection('https://api.cacholong.eu/api/v1/', 'YOUR-API-TOKEN') as api:
+        DnsRecordCtrl = DnsRecord(api)
 
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+        await DnsRecordCtrl.destroy("UUID_OF_DNS_RECORD")
 
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+# Execute main function
+asyncio.run(main())
+```
 
-## License
-For open source projects, say how it is licensed.
+## Support
+Questions, feedback, or suggestions? Send us an email at [ccloud-support@cacholong.nl].
 

cacholong_cloud_cli-0.3.4/README.md

@@ -0,0 +1,149 @@
+# CLI frontend
+
+The API client library for managing various resources.
+
+[Client Library Documentation](https://docs.cacholong.eu/api/)
+
+## Getting started
+
+To install this package you need to take a few steps before this works correctly
+1. Create an virtual environment: python3 -m venv <directory>
+2. Activate the environment: <directory>/bin/activate
+3. Now install the package: pip install cacholong-cloud-cli
+4. Or upgrade the package: pip install cacholong-cloud-cli --upgrade
+
+Now you can use the command `ccloud` on the system. Please note, make sure to activate the virtual environment before running the command `ccloud`.
+
+You will need an API-token. This token can be created using our panel at https://cp.cacholong.eu/#/user/settings/api. You can create an api token within your profile under API.
+
+When running the command `ccloud` for the first time it will ask you for an API-token.
+
+After that you will be able to run the following command:
+```bash
+ccloud accounts list
+```
+
+This will give you an overview of accounts where you have access to.
+
+## 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
+
+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.
+
+### 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(account="UUID_OF_ACCOUNT")
+        DnsZoneCtrl = DnsZone(api)
+        async for zone in DnsZoneCtrl.fetch_all(searchfilter):
+            print(zone["domain"])
+
+# Execute main function
+asyncio.run(main())
+```
+
+### Create a DNS-record
+```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:
+        DnsRecordCtrl = DnsRecord(api)
+
+        dns_record = DNSRecordCtrl.create()
+        dns_record["dns-zone"] = ResourceTuple("UUID_DNS_ZONE", "dns-zones")
+        dns_record["name"] = "localhost.example.nl"
+        dns_record["dns_record_type"] = "A"
+        dns_record["content"] = "127.0.0.1"
+        dns_record["ttl"] = 300
+        await DNSRecordCtrl.store(dns_record)
+
+# Execute main function
+asyncio.run(main())
+```
+
+### Update a DNS-record
+```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:
+        DnsRecordCtrl = DnsRecord(api)
+
+        dns_record = await DnsRecordCtrl.fetch("UUID_OF_DNS_RECORD")
+        dns_record["content"] = "127.0.0.1"
+
+        # Be careful: the above change will be applied automatically
+
+# Execute main function
+asyncio.run(main())
+```
+
+### Delete a DNS-record
+```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:
+        DnsRecordCtrl = DnsRecord(api)
+
+        await DnsRecordCtrl.destroy("UUID_OF_DNS_RECORD")
+
+# Execute main function
+asyncio.run(main())
+```
+
+## Support
+Questions, feedback, or suggestions? Send us an email at [ccloud-support@cacholong.nl].

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

@@ -1,9 +1,10 @@
 [tool.poetry]
 name = "cacholong-cloud-cli"
-version = "0.3.3"
+version = "0.3.4"
 description = "Cacholong CLI, manage cloud environments at Cacholong!"
 authors = ["Matthijs Möhlmann <matthijs@cacholong.nl>"]
 readme = "README.md"
+license = "MIT"
 packages = [
     { include = "cacholong_cli" },
     { include = "cacholong_sdk" },

cacholong_cloud_cli-0.3.3/README.md

@@ -1,94 +0,0 @@
-# CLI frontend
-
-The API client library for managing various resources.
-
-[Client Library Documentation](https://docs.cacholong.eu/api/)
-
-## Getting started
-
-You will need an API-token. This token can be created using our panel at https://cp.cacholong.eu/#/user/settings/api. You can create an api token within your profile under API.
-
-When running the command `ccloud` for the first time it will ask you for an API-token.
-
-After that you will be able to run the following command:
-```bash
-ccloud accounts list
-```
-
-This will give you an overview of accounts where you have access to.
-
-## 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
-
-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.
-
-### 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.
-
-## 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.
-
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
-
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
-
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
-
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
-
-## License
-For open source projects, say how it is licensed.