developer-platform-cli 0.3.0__py3-none-any.whl → 1.0.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,73 @@
1
+ Metadata-Version: 2.4
2
+ Name: developer-platform-cli
3
+ Version: 1.0.0
4
+ Summary: Command-line client for the Developer Platform API
5
+ Requires-Python: >=3.12
6
+ Requires-Dist: httpx<1,>=0.28
7
+ Requires-Dist: jsonschema<5,>=4.23
8
+ Requires-Dist: keyring<26,>=25
9
+ Requires-Dist: platformdirs<5,>=4
10
+ Requires-Dist: pydantic<3,>=2.10
11
+ Requires-Dist: rich<14,>=13.9
12
+ Requires-Dist: typer<1,>=0.15
13
+ Provides-Extra: dev
14
+ Requires-Dist: pytest<9,>=8.3; extra == 'dev'
15
+ Requires-Dist: respx<1,>=0.22; extra == 'dev'
16
+ Description-Content-Type: text/markdown
17
+
18
+ # Developer Platform CLI
19
+
20
+ This repository builds and releases the `devplat` command-line client for the
21
+ Developer Platform API. The [CLI guide](https://github.com/eseidinger/developer-platform/blob/main/docs/developers/cli.md)
22
+ documents commands and authentication.
23
+
24
+ `devplat` is the command-line client for the Developer Platform API. It supports
25
+ CI deployments and project administration, including hosted application access.
26
+ Use `devplat --help` and `devplat access --help` to inspect commands.
27
+
28
+ Install an editable development copy and run the checks:
29
+
30
+ ```bash
31
+ uv venv
32
+ uv pip install -e '.[dev]'
33
+ uv run --no-sync pytest tests
34
+ uv run --no-sync devplat contract check --output json
35
+ uv build
36
+ ```
37
+
38
+ Set the values returned when the deployment credential was created. Keep the
39
+ secret in the CI system's protected environment and disable shell tracing around
40
+ this step:
41
+
42
+ ```bash
43
+ export PLATFORM_API_URL=https://platform.example
44
+ export PLATFORM_TOKEN_ENDPOINT=\
45
+ https://identity.example/realms/platform/protocol/openid-connect/token
46
+ export PLATFORM_CLIENT_ID='...'
47
+ export PLATFORM_CLIENT_SECRET='...'
48
+ devplat deploy apply --project hello --file application.json --wait
49
+ ```
50
+
51
+ `PLATFORM_ACCESS_TOKEN` may be used instead of the deployment-credential
52
+ variables for a short-lived, externally obtained token. The CLI never persists
53
+ either form of authentication material. Deployment credentials authorize
54
+ deployment and observation only; access administration requires a human
55
+ project-administrator login or an externally supplied administrator token. See
56
+ the [CLI guide](https://github.com/eseidinger/developer-platform/blob/main/docs/developers/cli.md)
57
+ for profiles, login, access commands, and versioned updates.
58
+
59
+ ## Update the API contract
60
+
61
+ The checked-in `src/platform_cli/api_contract.json` is extracted from the API's
62
+ OpenAPI export in the [developer-platform repository](https://github.com/eseidinger/developer-platform).
63
+ After an API contract change, check out both repositories side by side and run:
64
+
65
+ ```bash
66
+ uv run --no-sync python scripts/generate-cli-contract.py --source ../developer-platform/docs/api/openapi.json
67
+ uv run --no-sync devplat contract check --output json
68
+ uv run --no-sync pytest tests
69
+ ```
70
+
71
+ Review and commit the resulting contract change here with any CLI command
72
+ updates. A tag `vMAJOR.MINOR.PATCH` must match `pyproject.toml`; the CLI
73
+ repository builds, tests, and publishes that version from its own CI workflow.
@@ -0,0 +1,16 @@
1
+ platform_cli/__init__.py,sha256=I4W0DEQ6mB2Y1aDxse7O9uMQuIk-d6awuC22hoZ8iCA,69
2
+ platform_cli/__main__.py,sha256=xHAn--ivfbfqpjnerSr3U-N9AutCL3ysmYL41kzCukg,21582
3
+ platform_cli/api_contract.json,sha256=KMBfk20LH-rqqQlkxmJSfcyYx1_REjnddF3TaRjJSBU,541065
4
+ platform_cli/authentication.py,sha256=8aHoE9Eb-EspFTHiioHMEa7HboO-rTxxgUWmpAVxVr8,8323
5
+ platform_cli/client.py,sha256=YRSJ-mOwbIrbW1zjb4TN94WXNlSHrnCQndZ-KIGr-kk,12234
6
+ platform_cli/commands.py,sha256=qDeNzGxNNWMW8KuEEUbuswP1xLpbtDLBt7h9vrgWI8g,30236
7
+ platform_cli/config.py,sha256=lTk_DpcRHKjyzaNbd68wIaOynXjjcXqEAf_PbhHEkow,3931
8
+ platform_cli/errors.py,sha256=uLHk5lAAX-D2TC7cAgQcaOxPXhaYps4qPGjMA4f-h08,1204
9
+ platform_cli/models.py,sha256=NedsOQa0m_0XlMopGoass5tNilYBOyV2xweky6vgDgI,2581
10
+ platform_cli/profiles.py,sha256=lEbGsyl_jvjpKh0Sq45ZSJN64eiRLLPIWaw6N6-N7q4,7067
11
+ platform_cli/registry.py,sha256=4GPLsnZDiFoGonDbMw2363O8bIoCCxJ98uZ7ERIOBHI,19307
12
+ platform_cli/tunnel.py,sha256=Xm_GCPamleJKDURL7qiejQLInzS9fs1ySt1PcbFv5gk,4136
13
+ developer_platform_cli-1.0.0.dist-info/METADATA,sha256=FY1zRNu7ZnYvsjJLFAcCuiX8UXp5IxxZg-alqq53xjU,2960
14
+ developer_platform_cli-1.0.0.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
15
+ developer_platform_cli-1.0.0.dist-info/entry_points.txt,sha256=M7MpiSzj86vx01JPP3zjnrykkQuxJjTnS9o5Rs0CAkI,55
16
+ developer_platform_cli-1.0.0.dist-info/RECORD,,
@@ -1,4 +1,4 @@
1
1
  Wheel-Version: 1.0
2
- Generator: hatchling 1.32.4
2
+ Generator: hatchling 1.33.0
3
3
  Root-Is-Purelib: true
4
4
  Tag: py3-none-any
platform_cli/__init__.py CHANGED
@@ -1,3 +1,3 @@
1
1
  """Developer Platform command-line client."""
2
2
 
3
- __version__ = "0.3.0"
3
+ __version__ = "1.0.0"