Merge pull request #26 from ByteInternet/add-cli-entrypoint

add simple cli entrypoints for api functionality

.github/workflows/test.yaml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.7', '3.8', '3.9', '3.10']
+        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
 
     steps:
       - uses: actions/checkout@v3

README.md

@@ -18,6 +18,36 @@ pip install -r requirements/development.txt
 
 Each Hypernode has an API token associated with it, you can use that to talk to the API directly. You can find the token in `/etc/hypernode/hypernode_api_token`. For API tokens with special permissions please contact [email protected]. Not all functionality in the API is currently generally available but if you'd like to start automating and have an interesting use-case we'd love to hear from you.
 
+## Using the library from the commandline
+
+In the `bin/` directory you'll find entry points to interact with the API directly from the commandline.
+
+See for example:
+```bash
+$ export PYTHONPATH=.
+
+$ ./bin/get_slas --help
+usage: get_slas [-h]
+
+List all available SLAs.
+
+Example:
+$ ./bin/get_slas
+[
+  {
+    "id": 123,
+    "code": "sla-standard",
+    "name": "SLA Standard",
+    "price": 1234,
+    "billing_period": 1,
+    "billing_period_unit": "month"
+  },
+  ...
+]
+
+optional arguments:
+  -h, --help  show this help message and exit
+```
 
 ### Installing the library in your project
 
@@ -56,7 +86,7 @@ client.set_app_setting('yourhypernodeappname', 'php_version', '8.1').json()
 {'name': 'yourhypernodeappname', 'type': 'persistent', 'php_version': '8.1', ...}
 ```
 
-To even performing acts of cloud automation, like scaling to the first next larger plan:
+You can even perform acts of cloud automation, like scaling to the first next larger plan:
 ```python
 client.xgrade(
     'yourhypernodeappname',

bin/block_attack

@@ -0,0 +1 @@
+command

bin/check_payment_information_for_app

@@ -0,0 +1 @@
+command

bin/check_xgrade

@@ -0,0 +1 @@
+command

bin/command

@@ -0,0 +1,14 @@
+#!/usr/bin/env python3
+import os
+import sys
+from hypernode_api_python import commands
+
+
+if __name__ == '__main__':
+    command = os.path.basename(__file__)
+
+    if hasattr(commands, command):
+        sys.exit(getattr(commands, command)() or 0)
+    else:
+        sys.stderr.write("Command '{}' not found in hypernode_api_python.commands\n".format(command))
+        sys.exit(1)

bin/create_brancher

@@ -0,0 +1 @@
+command

bin/destroy_brancher

@@ -0,0 +1 @@
+command

bin/get_active_branchers

@@ -0,0 +1 @@
+command

bin/get_active_products

@@ -0,0 +1 @@
+command

bin/get_app_configurations

@@ -0,0 +1 @@
+command

bin/get_app_flavor

@@ -0,0 +1 @@
+command

bin/get_app_info

@@ -0,0 +1 @@
+command

bin/get_available_backups_for_app

@@ -0,0 +1 @@
+command

bin/get_block_attack_descriptions

@@ -0,0 +1 @@
+command

bin/get_cluster_relations

@@ -0,0 +1 @@
+command

bin/get_current_product_for_app

@@ -0,0 +1 @@
+command

bin/get_eav_description

@@ -0,0 +1 @@
+command

bin/get_flows

@@ -0,0 +1 @@
+command

bin/get_next_best_plan_for_app

@@ -0,0 +1 @@
+command

bin/get_product_info

@@ -0,0 +1 @@
+command

bin/get_sla

@@ -0,0 +1 @@
+command

bin/get_slas

@@ -0,0 +1 @@
+command

bin/get_whitelist_options

@@ -0,0 +1 @@
+command

bin/get_whitelist_rules

@@ -0,0 +1 @@
+command

bin/validate_app_name

@@ -0,0 +1 @@
+command

bin/xgrade

@@ -0,0 +1 @@
+command

hypernode_api_python/client.py

@@ -331,6 +331,7 @@ def get_app_eav_description(self):
         """
         return self.requests("GET", HYPERNODE_API_APP_EAV_DESCRIPTION_ENDPOINT)
 
+    # TODO: add entrypoint for this method in bin/ and commands.py
     def set_app_setting(self, app_name, attribute, value):
         """
         Update a setting on the app, like the PHP or MySQL version. See
@@ -384,7 +385,7 @@ def get_app_configurations(self):
         return self.requests("GET", HYPERNODE_API_APP_CONFIGURATION_ENDPOINT)
 
     def get_cluster_relations(self, app_name):
-        """ "
+        """
         List all relations for the specified app. This will return all the
         relations that are currently configured for the specified app.
 
@@ -780,6 +781,7 @@ def xgrade(self, app_name, data):
             "PATCH", HYPERNODE_API_APP_XGRADE_ENDPOINT.format(app_name), data=data
         )
 
+    # TODO: add entrypoint for this method in bin/ and commands.py
     def order_hypernode(self, data):
         """
         Orders a new Hypernode. Note that you can not do this with the API permissions