proxygen-cli 2.1.4__tar.gz → 2.1.5__tar.gz

proxygen_cli-2.1.5/PKG-INFO

@@ -0,0 +1,104 @@
+Metadata-Version: 2.1
+Name: proxygen-cli
+Version: 2.1.5
+Summary: CLI for interacting with NHSD APIM's proxygen service
+Home-page: https://github.com/NHSDigital/proxygen-cli
+Author: Ben Strutt
+Author-email: ben.strutt1@nhs.net
+Requires-Python: >=3.9,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: click (>=8.1.3,<9.0.0)
+Requires-Dist: cryptography (>=36.0.1,<37.0.0)
+Requires-Dist: lxml (>=4.7.1,<5.0.0)
+Requires-Dist: pydantic (>=1.9.1,<2.0.0)
+Requires-Dist: pyjwt (>=2.3.0,<3.0.0)
+Requires-Dist: pyyaml (>=6.0,<7.0)
+Requires-Dist: requests (>=2.27.1,<3.0.0)
+Requires-Dist: tabulate (>=0.9.0,<0.10.0)
+Requires-Dist: yaspin (>=2.2.0,<3.0.0)
+Project-URL: Repository, https://github.com/NHSDigital/proxygen-cli
+Description-Content-Type: text/markdown
+
+# proxygen-cli
+
+## Installation
+
+Installation is straightforward using pip:
+```
+pip install proxygen-cli
+```
+After installation, the `proxygen` executable is available. Typing `proxygen` displays a list of available commands.
+
+
+## Configuration
+
+### Credentials
+
+The CLI requires client credentials, which can be obtained from the `platforms-api-producer-support` Slack channel.
+
+All users should also have individual credentials. `proxygen-cli` needs to know about them.
+You can setup the credentials in `proxygen-cli` using:
+```
+proxygen credentials set
+```
+This command prompts you to enter your `client_id`, `client_secret`, `username`, and `password`. 
+To update credentials in the future, use:
+```
+proxygen credentials set <KEY> <VALUE>
+```
+
+
+### Settings
+To specify the API you are developing for, use:
+```
+proxygen settings set api <API-NAME>
+```
+Your user must have the appropriate permissions for managing instances, secrets, and specifications related to the specified API. If permissions are insufficient, commands will fail. Reach out to the `platforms-api-producer-support` channel for assistance with permissions.
+
+
+## Commands
+Commands are documented inside the CLI itself.
+Type `proxygen` to see a full list of available commands.
+
+For a full user guide for `proxygen-cli` see this [confluence page](https://nhsd-confluence.digital.nhs.uk/display/APM/Proxygen+CLI+user+guide).
+
+### Deploying an API instance
+To deploy an instance of an API you will need an OAS specification file. The OAS specification file can be deployed to an environment using the following command:
+```
+proxygen instance deploy <env> <base-path> path/to/specification.yaml
+```
+To manage your instances type `proxygen instance --help` for a list of available commands.
+
+### Publishing an API sepcification
+To publish your API specification, first deploy it on the UAT version of Bloomreach, then on production. Publishing to UAT allows you to preview the API documentation's appearance and catch any errors in the code before going live.
+
+Use the following command to publish an API specification:
+```
+# Production
+proxygen spec publish <path_to_spec>
+ 
+# UAT
+proxygen spec publish <path_to_spec> --uat
+```
+To manage your instances type `proxygen spec --help` for a list of available commands.
+
+### Deploying a secret
+The API key, considered sensitive information, is securely stored within the API platform as a 'secret'. Before configuring any instances reliant on this key, it's necessary to deploy it.
+
+Use the following command to deploy a secret:
+```
+proxygen secret put <env> <apikey> --apikey --secret-file path/to/secret.txt
+```
+To manage your instances type `proxygen secret --help` for a list of available commands.
+
+### Interacting with your docker repository
+To enable the push and pull of images from the API Management ECR repository, you will need to acquire authentication details.
+
+Use the following command to obtain a docker token:
+```
+$(proxygen docker get-login)
+```

proxygen_cli-2.1.5/README.md

@@ -0,0 +1,79 @@
+# proxygen-cli
+
+## Installation
+
+Installation is straightforward using pip:
+```
+pip install proxygen-cli
+```
+After installation, the `proxygen` executable is available. Typing `proxygen` displays a list of available commands.
+
+
+## Configuration
+
+### Credentials
+
+The CLI requires client credentials, which can be obtained from the `platforms-api-producer-support` Slack channel.
+
+All users should also have individual credentials. `proxygen-cli` needs to know about them.
+You can setup the credentials in `proxygen-cli` using:
+```
+proxygen credentials set
+```
+This command prompts you to enter your `client_id`, `client_secret`, `username`, and `password`. 
+To update credentials in the future, use:
+```
+proxygen credentials set <KEY> <VALUE>
+```
+
+
+### Settings
+To specify the API you are developing for, use:
+```
+proxygen settings set api <API-NAME>
+```
+Your user must have the appropriate permissions for managing instances, secrets, and specifications related to the specified API. If permissions are insufficient, commands will fail. Reach out to the `platforms-api-producer-support` channel for assistance with permissions.
+
+
+## Commands
+Commands are documented inside the CLI itself.
+Type `proxygen` to see a full list of available commands.
+
+For a full user guide for `proxygen-cli` see this [confluence page](https://nhsd-confluence.digital.nhs.uk/display/APM/Proxygen+CLI+user+guide).
+
+### Deploying an API instance
+To deploy an instance of an API you will need an OAS specification file. The OAS specification file can be deployed to an environment using the following command:
+```
+proxygen instance deploy <env> <base-path> path/to/specification.yaml
+```
+To manage your instances type `proxygen instance --help` for a list of available commands.
+
+### Publishing an API sepcification
+To publish your API specification, first deploy it on the UAT version of Bloomreach, then on production. Publishing to UAT allows you to preview the API documentation's appearance and catch any errors in the code before going live.
+
+Use the following command to publish an API specification:
+```
+# Production
+proxygen spec publish <path_to_spec>
+ 
+# UAT
+proxygen spec publish <path_to_spec> --uat
+```
+To manage your instances type `proxygen spec --help` for a list of available commands.
+
+### Deploying a secret
+The API key, considered sensitive information, is securely stored within the API platform as a 'secret'. Before configuring any instances reliant on this key, it's necessary to deploy it.
+
+Use the following command to deploy a secret:
+```
+proxygen secret put <env> <apikey> --apikey --secret-file path/to/secret.txt
+```
+To manage your instances type `proxygen secret --help` for a list of available commands.
+
+### Interacting with your docker repository
+To enable the push and pull of images from the API Management ECR repository, you will need to acquire authentication details.
+
+Use the following command to obtain a docker token:
+```
+$(proxygen docker get-login)
+```

{proxygen_cli-2.1.4 → proxygen_cli-2.1.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "proxygen-cli"
-version = "2.1.4"
+version = "2.1.5"
 description = "CLI for interacting with NHSD APIM's proxygen service"
 authors = ["Ben Strutt <ben.strutt1@nhs.net>"]
 readme = "README.md"

proxygen_cli-2.1.4/PKG-INFO

@@ -1,71 +0,0 @@
-Metadata-Version: 2.1
-Name: proxygen-cli
-Version: 2.1.4
-Summary: CLI for interacting with NHSD APIM's proxygen service
-Home-page: https://github.com/NHSDigital/proxygen-cli
-Author: Ben Strutt
-Author-email: ben.strutt1@nhs.net
-Requires-Python: >=3.9,<4.0
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: click (>=8.1.3,<9.0.0)
-Requires-Dist: cryptography (>=36.0.1,<37.0.0)
-Requires-Dist: lxml (>=4.7.1,<5.0.0)
-Requires-Dist: pydantic (>=1.9.1,<2.0.0)
-Requires-Dist: pyjwt (>=2.3.0,<3.0.0)
-Requires-Dist: pyyaml (>=6.0,<7.0)
-Requires-Dist: requests (>=2.27.1,<3.0.0)
-Requires-Dist: tabulate (>=0.9.0,<0.10.0)
-Requires-Dist: yaspin (>=2.2.0,<3.0.0)
-Project-URL: Repository, https://github.com/NHSDigital/proxygen-cli
-Description-Content-Type: text/markdown
-
-# proxygen-cli
-
-## Installation
-
-Should be as simple as
-```
-pip install proxygen-cli
-```
-The python package includes an execuatable `proxygen`.
-Type `proxygen` to see a list of available commands.
-
-
-## Configuration
-
-### Credentials
-
-The CLI has its own client credentials, which need to be input.
-Contact `deathstar` squad or the `platforms-api-producer-support` slack channel to find out what they are.
-
-All users should also have individual credentials. `proxygen-cli` needs to know about them.
-
-Simply execute the following command which will prompt you to enter your `client_id`, `client_secret`, `username`, and `password`:
-```
-proxygen credentials set
-```
-
-If you need to update any credentials in the future, use the following command:
-```
-proxygen credentials set <KEY> <VALUE>
-```
-
-
-### Settings
-`proxygen-cli` needs to know what API you are developing.
-
-```
-proxygen settings set api <API-NAME>
-```
-Your user must have permissions to manipulate instances/secrets/specs for the API you set here.
-If you do not have sufficient permissions commands will fail.
-If you believe your permissions are incorrect, contact the `platforms-api-producer-support` channel.
-
-## Commands
-Commands are documented inside the CLI itself.
-Type `proxygen` to see a list of available commands.
-

proxygen_cli-2.1.4/README.md

@@ -1,45 +0,0 @@
-# proxygen-cli
-
-## Installation
-
-Should be as simple as
-```
-pip install proxygen-cli
-```
-The python package includes an execuatable `proxygen`.
-Type `proxygen` to see a list of available commands.
-
-
-## Configuration
-
-### Credentials
-
-The CLI has its own client credentials, which need to be input.
-Contact `deathstar` squad or the `platforms-api-producer-support` slack channel to find out what they are.
-
-All users should also have individual credentials. `proxygen-cli` needs to know about them.
-
-Simply execute the following command which will prompt you to enter your `client_id`, `client_secret`, `username`, and `password`:
-```
-proxygen credentials set
-```
-
-If you need to update any credentials in the future, use the following command:
-```
-proxygen credentials set <KEY> <VALUE>
-```
-
-
-### Settings
-`proxygen-cli` needs to know what API you are developing.
-
-```
-proxygen settings set api <API-NAME>
-```
-Your user must have permissions to manipulate instances/secrets/specs for the API you set here.
-If you do not have sufficient permissions commands will fail.
-If you believe your permissions are incorrect, contact the `platforms-api-producer-support` channel.
-
-## Commands
-Commands are documented inside the CLI itself.
-Type `proxygen` to see a list of available commands.