proxygen-cli 4.0.0__py3-none-any.whl → 4.0.2__py3-none-any.whl

proxygen_cli/test/command_credentials_test.py

@@ -10,6 +10,7 @@ import proxygen_cli.cli.command_credentials as cmd_credentials
 from proxygen_cli.lib.credentials import Credentials
 CLIENT_ID = os.environ["PROXYGEN_CLIENT_ID"]
 CLIENT_SECRET = os.environ["PROXYGEN_CLIENT_SECRET"]
+# added below urls to resolve sonar cloud issues.
 KEYCLOAK_URL = "https://identity.prod.api.platform.nhs.uk/realms/api-producers"
 MOCK_KEYCLOAK_URL = "https://mock-keycloak-url.nhs.uk"
 BASE_URL_LABEL = "base_url: "

{proxygen_cli-4.0.0.dist-info → proxygen_cli-4.0.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: proxygen-cli
-Version: 4.0.0
+Version: 4.0.2
 Summary: CLI for interacting with NHSD APIM's proxygen service
 Author: Ben Strutt
 Author-email: ben.strutt1@nhs.net
@@ -38,9 +38,10 @@ After installation, the `proxygen` executable is available. Typing `proxygen` di
 ### Settings
 To specify the API you are developing for, use:
 ```
-proxygen settings set api <API-NAME>
+proxygen settings set api <API-NAME> --env <ptl/prod>
 ```
 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.
+Parameter --env is optional, if the environment is not provided then CLI will default to Prod.
 
 
 ### Credentials
@@ -54,9 +55,10 @@ If you are setting up user access for the first time you will first need to requ
 
 To setup the Proxygen CLI credentials for the first time with user access enter the following command:
 ```
-proxygen credentials set
+proxygen credentials set --env <ptl/prod>
 ```
 The CLI will ask you for your username, and password. These credentials will be securely stored on your local machine in the directory ~/.proxygen/credentials.yaml. The client_id and secret used for user access will be automatically added to this file after running the command.
+Parameter --env is optional, if the environment is not provided then CLI will default to Prod.
 
 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 API platform team via the [platforms-api-producer-support](https://nhsdigital-platforms.slack.com/archives/C016JRWN6AY) channel.
 
@@ -69,16 +71,17 @@ After having set up your API using the instructions at [Getting set up with prox
 
 Using this information enter the following command:
 ```
-proxygen credentials set private_key_path <PATH_TO_PRIVATE_KEY> key_id <KEY_ID_FOR_PRIVATE_KEY> client_id <MACHINE_USER_CLIENT_ID>
+proxygen credentials set private_key_path <PATH_TO_PRIVATE_KEY> key_id <KEY_ID_FOR_PRIVATE_KEY> client_id <MACHINE_USER_CLIENT_ID> --env <ptl/prod>
 ```
 The CLI will ask you for your username, and password. For machine authentication, the username and password must be left blank. The credentials will be securely stored in the directory ~/.proxygen/credentials.yaml.
+Parameter --env is optional, if the environment is not provided then CLI will default to Prod.
 
 > **_NOTE:_**  If you are switching between using user access and machine-user access bare in mind:
 > - proxygen-cli will favour user access if username and password credentials are set
 > - User access uses proxygen-cli-user-client as a client_id. If you switch between access modes remember to switch the client_id
 > - The value for client_secret should remain untouched as it is not used for machine-user access
 > - If you lose the client_secret for then proxygen-cli-user-client then reach out to the platforms-api-producer-support channel for it
-
+> - From version 4.0.0 CLI will prompt for client_id and client_secret instead of setting automatically.
 
 ## Commands
 Commands are documented inside the CLI itself.
@@ -100,7 +103,7 @@ Use the following command to publish an API specification:
 ```
 # Production
 proxygen spec publish <path_to_spec>
- 
+
 # UAT
 proxygen spec publish <path_to_spec> --uat
 ```

{proxygen_cli-4.0.0.dist-info → proxygen_cli-4.0.2.dist-info}/RECORD

@@ -18,7 +18,7 @@ proxygen_cli/lib/spec.py,sha256=EeInv8C_Q9Tfcuma0xO3zFaUgJYY5p1NdogKNMmPlG8,3037
 proxygen_cli/lib/spec_server.py,sha256=KQZa_D9AcV7zuo0PymkqiytCMuUj8uUIRchL7US-bSk,1042
 proxygen_cli/lib/version.py,sha256=Hd-u_0SRmkKLFY0UShahb1_Eb-qO6pdO1AEFXl-cI8M,495
 proxygen_cli/test/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-proxygen_cli/test/command_credentials_test.py,sha256=rPqG_xI7hZvoTDtwHbdFb3UrZETTIgCZLIemlpXxQWo,11000
+proxygen_cli/test/command_credentials_test.py,sha256=fB6NH1fwBsmEeJuuNYIfIjUh7yPidV-HrhDCWl555eU,11050
 proxygen_cli/test/command_instance_test.py,sha256=eT_WQOLNMYN2yf9T5M1neziEprUF5DgUMzOx8O09mAw,13013
 proxygen_cli/test/command_main_test.py,sha256=ecbJJl8m7AWruHf_1uEKIvq_kBRib-ozOFK9JP5XeAk,1382
 proxygen_cli/test/command_pytest_nhsd_apim_token_test.py,sha256=vtonBsWEuOHBP3MAg0QRI10ZqH0-_xqR8aOXIXEgwpM,688
@@ -31,7 +31,7 @@ proxygen_cli/test/fixtures/client.pem,sha256=of0DmJ2vSdD8Ug2xVXwv0rVB1smmqBPbddJ
 proxygen_cli/test/fixtures/secret.txt,sha256=EcT1Cxom6voGR8HJ-X0L5b-W5cdvsnT4MACY-hOMdxI,30
 proxygen_cli/test/mock_private_key.py,sha256=TLxLYUmq2nVQYHa7dJ61sDavh-BjTZ9dhJZwcjELY74,570
 proxygen_cli/test/validate_cli_version_test.py,sha256=qmkFX1sKfTm96AjpwOTYIsJoV10OxZ25Bu5z-234PvA,786
-proxygen_cli-4.0.0.dist-info/METADATA,sha256=i2ftrr_TdE7hODKauBHNtLcoPVU4x4xKAJBaszP-8no,6523
-proxygen_cli-4.0.0.dist-info/WHEEL,sha256=EGEvSphFYqXKs23-kQBeyNoJP1nrT8ZJKQoi5p5DYL8,88
-proxygen_cli-4.0.0.dist-info/entry_points.txt,sha256=dJloORmm8rKsrnMVatQD23--gsD49TTCfv565S4z6Yo,63
-proxygen_cli-4.0.0.dist-info/RECORD,,
+proxygen_cli-4.0.2.dist-info/METADATA,sha256=oOmuP_6_GEddArZtO0MacT20jdCkhyyX0POfUBkTLvI,6962
+proxygen_cli-4.0.2.dist-info/WHEEL,sha256=EGEvSphFYqXKs23-kQBeyNoJP1nrT8ZJKQoi5p5DYL8,88
+proxygen_cli-4.0.2.dist-info/entry_points.txt,sha256=dJloORmm8rKsrnMVatQD23--gsD49TTCfv565S4z6Yo,63
+proxygen_cli-4.0.2.dist-info/RECORD,,