Support of Python3.10 and Ubuntu22
[osm/osmclient.git] / README.md
index 1791594..c53049e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -126,7 +126,7 @@ from osmclient.common.exceptions import ClientException
 hostname = "127.0.0.1"
 myclient = client.Client(host=hostname, sol005=True)
 resp = myclient.nsd.list()
-print yaml.safe_dump(resp)
+print yaml.safe_dump(resp, indent=4, default_flow_style=False)
 ```
 
 ### Simple Python code to get the list of VNF packages from a specific user and project
@@ -151,7 +151,7 @@ if project is not None:
    kwargs['project']=project
 myclient = client.Client(host=hostname, sol005=True, **kwargs)
 resp = myclient.vnfd.list()
-print yaml.safe_dump(resp)
+print yaml.safe_dump(resp, indent=4, default_flow_style=False)
 ```
 
 ## Enable autocompletion
@@ -169,3 +169,12 @@ Then you can add the following to your $HOME/.bashrc file:
 . .bash_completion.d/osm-complete.sh
 ```
 
+## Future work
+
+- Create command classes for list and show operations
+- Option `-c` for list and show operations to filter output and show only selected columns
+- Option `-o <FORMAT>` to adapt output format (table, csv, yaml, json, jsonpath)
+- Command ns-status to show the deployment status (RO) and configuration status (VCA) in an appealing format
+- See how to deprecate commands and options: <https://stackoverflow.com/questions/50366719/correct-way-to-deprecate-parameter-alias-in-click>
+- Evaluate the possibility to re-structure code to uniform all commands: `check`, `table_headers`, `run`, `output`
+