Metadata-Version: 2.1
Name: proxygen-cli
Version: 2.0.9
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.8,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: click (>=8.1.3,<9.0.0)
Requires-Dist: cryptography (>=38.0.3,<39.0.0)
Requires-Dist: lxml (>=4.9.1,<5.0.0)
Requires-Dist: pydantic (>=1.10.2,<2.0.0)
Requires-Dist: pyjwt (>=2.6.0,<3.0.0)
Requires-Dist: pyyaml (>=6.0,<7.0)
Requires-Dist: requests (>=2.28.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

All users should have individual credentials.
`proxygen-cli` needs to know about them.

```
proxygen credentials set username <USERNAME>
proxygen credentials set password <PASSWORD>
```

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.
```
proxgen credentials set client_id <CLIENT_ID>
proxgen credentials set client_secret <CLIENT_SECRET>
```


### 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.

