previty-cli 0.1.0__tar.gz → 0.1.2__tar.gz
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.
- {previty_cli-0.1.0 → previty_cli-0.1.2}/PKG-INFO +4 -46
- {previty_cli-0.1.0 → previty_cli-0.1.2}/README.md +3 -45
- {previty_cli-0.1.0 → previty_cli-0.1.2}/src/previty_cli/__init__.py +1 -1
- {previty_cli-0.1.0 → previty_cli-0.1.2}/.gitignore +0 -0
- {previty_cli-0.1.0 → previty_cli-0.1.2}/LICENSE +0 -0
- {previty_cli-0.1.0 → previty_cli-0.1.2}/pyproject.toml +0 -0
- {previty_cli-0.1.0 → previty_cli-0.1.2}/src/previty_cli/AGENTS.md +0 -0
- {previty_cli-0.1.0 → previty_cli-0.1.2}/src/previty_cli/__main__.py +0 -0
- {previty_cli-0.1.0 → previty_cli-0.1.2}/src/previty_cli/api/__init__.py +0 -0
- {previty_cli-0.1.0 → previty_cli-0.1.2}/src/previty_cli/api/client.py +0 -0
- {previty_cli-0.1.0 → previty_cli-0.1.2}/src/previty_cli/api/models.py +0 -0
- {previty_cli-0.1.0 → previty_cli-0.1.2}/src/previty_cli/app.py +0 -0
- {previty_cli-0.1.0 → previty_cli-0.1.2}/src/previty_cli/clock.py +0 -0
- {previty_cli-0.1.0 → previty_cli-0.1.2}/src/previty_cli/commands/__init__.py +0 -0
- {previty_cli-0.1.0 → previty_cli-0.1.2}/src/previty_cli/commands/_common.py +0 -0
- {previty_cli-0.1.0 → previty_cli-0.1.2}/src/previty_cli/commands/agents.py +0 -0
- {previty_cli-0.1.0 → previty_cli-0.1.2}/src/previty_cli/commands/apps.py +0 -0
- {previty_cli-0.1.0 → previty_cli-0.1.2}/src/previty_cli/commands/auth.py +0 -0
- {previty_cli-0.1.0 → previty_cli-0.1.2}/src/previty_cli/commands/checks.py +0 -0
- {previty_cli-0.1.0 → previty_cli-0.1.2}/src/previty_cli/commands/readiness.py +0 -0
- {previty_cli-0.1.0 → previty_cli-0.1.2}/src/previty_cli/commands/results.py +0 -0
- {previty_cli-0.1.0 → previty_cli-0.1.2}/src/previty_cli/commands/sources.py +0 -0
- {previty_cli-0.1.0 → previty_cli-0.1.2}/src/previty_cli/config.py +0 -0
- {previty_cli-0.1.0 → previty_cli-0.1.2}/src/previty_cli/errors.py +0 -0
- {previty_cli-0.1.0 → previty_cli-0.1.2}/src/previty_cli/exit_codes.py +0 -0
- {previty_cli-0.1.0 → previty_cli-0.1.2}/src/previty_cli/output/__init__.py +0 -0
- {previty_cli-0.1.0 → previty_cli-0.1.2}/src/previty_cli/output/json.py +0 -0
- {previty_cli-0.1.0 → previty_cli-0.1.2}/src/previty_cli/output/markdown.py +0 -0
- {previty_cli-0.1.0 → previty_cli-0.1.2}/src/previty_cli/output/table.py +0 -0
- {previty_cli-0.1.0 → previty_cli-0.1.2}/src/previty_cli/py.typed +0 -0
- {previty_cli-0.1.0 → previty_cli-0.1.2}/src/previty_cli/redact.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.5
|
|
2
2
|
Name: previty-cli
|
|
3
|
-
Version: 0.1.
|
|
3
|
+
Version: 0.1.2
|
|
4
4
|
Summary: Command-line interface for the Previty public API
|
|
5
5
|
Project-URL: Homepage, https://previty.de
|
|
6
6
|
Author: Previty GmbH
|
|
@@ -49,9 +49,8 @@ previty check run --app <app-id> --wait
|
|
|
49
49
|
previty results <check-id> --status fail,unclear --format markdown
|
|
50
50
|
```
|
|
51
51
|
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
argument.
|
|
52
|
+
An organization owner must first allow API access for the organization in the Organization Settings. Then create
|
|
53
|
+
an API key in the web app under User Settings, API keys, in your user settings.
|
|
55
54
|
|
|
56
55
|
## Commands
|
|
57
56
|
|
|
@@ -129,54 +128,13 @@ Fixed for v1.
|
|
|
129
128
|
| `PREVITY_CONFIG_DIR` | Overrides the location |
|
|
130
129
|
| `PREVITY_API_KEY` | Takes precedence over the stored key |
|
|
131
130
|
| `PREVITY_API_URL` | Overrides the stored URL (default `https://api.previty.de/public/v1`) |
|
|
132
|
-
| `PREVITY_ALLOW_INSECURE_LOCALHOST=1` | Allows `http://localhost` / `127.0.0.1` for development |
|
|
133
131
|
|
|
134
|
-
The key is only ever sent to `api.previty.de`
|
|
132
|
+
The key is only ever sent to `api.previty.de` over https;
|
|
135
133
|
any other host is a usage error before a request is made. Redirects are never
|
|
136
134
|
followed. Tracebacks are off, and the key is masked in all output. The CLI warns if
|
|
137
135
|
the credentials file is readable by other users. On Windows, POSIX modes do not
|
|
138
136
|
apply; the per-user `AppData` folder is relied on.
|
|
139
137
|
|
|
140
|
-
## Development
|
|
141
|
-
|
|
142
|
-
```sh
|
|
143
|
-
uv sync
|
|
144
|
-
./.husky/install.sh # conventional-commit and branch-name hooks
|
|
145
|
-
uv run ruff check . && uv run ruff format --check .
|
|
146
|
-
uv run mypy --strict src
|
|
147
|
-
uv run pytest
|
|
148
|
-
uv run python scripts/measure_startup.py # previty --help budget: 300 ms
|
|
149
|
-
```
|
|
150
|
-
|
|
151
|
-
Commits follow `<type>(scope): <description>` on a branch named
|
|
152
|
-
`feature/<TICKET>-<title>`, like the other Previty repositories.
|
|
153
|
-
|
|
154
|
-
### API models
|
|
155
|
-
|
|
156
|
-
`src/previty_cli/api/models.py` is generated with `datamodel-code-generator` from a
|
|
157
|
-
pinned copy of the server's OpenAPI document, `openapi/public-v1.json`. Never edit
|
|
158
|
-
either file by hand. To update them:
|
|
159
|
-
|
|
160
|
-
```sh
|
|
161
|
-
uv run python scripts/sync_openapi.py ../workspace-service/openapi/public-v1.json
|
|
162
|
-
# or from a running API:
|
|
163
|
-
uv run python scripts/sync_openapi.py https://api.dev.previty.de/public/v1/openapi.json
|
|
164
|
-
uv run python scripts/sync_openapi.py # regenerate from the pin only
|
|
165
|
-
uv run python scripts/sync_openapi.py --check # what CI runs: fail on drift
|
|
166
|
-
```
|
|
167
|
-
|
|
168
|
-
### Smoke test
|
|
169
|
-
|
|
170
|
-
`PREVITY_API_KEY=<dev key> scripts/smoke_dev.sh` exercises the CLI against
|
|
171
|
-
`api.dev.previty.de` (see the script for the optional `SMOKE_APP_ID` and
|
|
172
|
-
`SMOKE_RUN_CHECK` switches).
|
|
173
|
-
|
|
174
|
-
### Release
|
|
175
|
-
|
|
176
|
-
Bump `version` in `pyproject.toml` and `src/previty_cli/__init__.py`, merge, then push
|
|
177
|
-
a tag `vX.Y.Z`. The release workflow builds the wheel and sdist and publishes to PyPI
|
|
178
|
-
with trusted publishing (OIDC, no stored token).
|
|
179
|
-
|
|
180
138
|
## Licence
|
|
181
139
|
|
|
182
140
|
Proprietary, (c) Previty GmbH. All rights reserved. See `LICENSE`.
|
|
@@ -26,9 +26,8 @@ previty check run --app <app-id> --wait
|
|
|
26
26
|
previty results <check-id> --status fail,unclear --format markdown
|
|
27
27
|
```
|
|
28
28
|
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
argument.
|
|
29
|
+
An organization owner must first allow API access for the organization in the Organization Settings. Then create
|
|
30
|
+
an API key in the web app under User Settings, API keys, in your user settings.
|
|
32
31
|
|
|
33
32
|
## Commands
|
|
34
33
|
|
|
@@ -106,54 +105,13 @@ Fixed for v1.
|
|
|
106
105
|
| `PREVITY_CONFIG_DIR` | Overrides the location |
|
|
107
106
|
| `PREVITY_API_KEY` | Takes precedence over the stored key |
|
|
108
107
|
| `PREVITY_API_URL` | Overrides the stored URL (default `https://api.previty.de/public/v1`) |
|
|
109
|
-
| `PREVITY_ALLOW_INSECURE_LOCALHOST=1` | Allows `http://localhost` / `127.0.0.1` for development |
|
|
110
108
|
|
|
111
|
-
The key is only ever sent to `api.previty.de`
|
|
109
|
+
The key is only ever sent to `api.previty.de` over https;
|
|
112
110
|
any other host is a usage error before a request is made. Redirects are never
|
|
113
111
|
followed. Tracebacks are off, and the key is masked in all output. The CLI warns if
|
|
114
112
|
the credentials file is readable by other users. On Windows, POSIX modes do not
|
|
115
113
|
apply; the per-user `AppData` folder is relied on.
|
|
116
114
|
|
|
117
|
-
## Development
|
|
118
|
-
|
|
119
|
-
```sh
|
|
120
|
-
uv sync
|
|
121
|
-
./.husky/install.sh # conventional-commit and branch-name hooks
|
|
122
|
-
uv run ruff check . && uv run ruff format --check .
|
|
123
|
-
uv run mypy --strict src
|
|
124
|
-
uv run pytest
|
|
125
|
-
uv run python scripts/measure_startup.py # previty --help budget: 300 ms
|
|
126
|
-
```
|
|
127
|
-
|
|
128
|
-
Commits follow `<type>(scope): <description>` on a branch named
|
|
129
|
-
`feature/<TICKET>-<title>`, like the other Previty repositories.
|
|
130
|
-
|
|
131
|
-
### API models
|
|
132
|
-
|
|
133
|
-
`src/previty_cli/api/models.py` is generated with `datamodel-code-generator` from a
|
|
134
|
-
pinned copy of the server's OpenAPI document, `openapi/public-v1.json`. Never edit
|
|
135
|
-
either file by hand. To update them:
|
|
136
|
-
|
|
137
|
-
```sh
|
|
138
|
-
uv run python scripts/sync_openapi.py ../workspace-service/openapi/public-v1.json
|
|
139
|
-
# or from a running API:
|
|
140
|
-
uv run python scripts/sync_openapi.py https://api.dev.previty.de/public/v1/openapi.json
|
|
141
|
-
uv run python scripts/sync_openapi.py # regenerate from the pin only
|
|
142
|
-
uv run python scripts/sync_openapi.py --check # what CI runs: fail on drift
|
|
143
|
-
```
|
|
144
|
-
|
|
145
|
-
### Smoke test
|
|
146
|
-
|
|
147
|
-
`PREVITY_API_KEY=<dev key> scripts/smoke_dev.sh` exercises the CLI against
|
|
148
|
-
`api.dev.previty.de` (see the script for the optional `SMOKE_APP_ID` and
|
|
149
|
-
`SMOKE_RUN_CHECK` switches).
|
|
150
|
-
|
|
151
|
-
### Release
|
|
152
|
-
|
|
153
|
-
Bump `version` in `pyproject.toml` and `src/previty_cli/__init__.py`, merge, then push
|
|
154
|
-
a tag `vX.Y.Z`. The release workflow builds the wheel and sdist and publishes to PyPI
|
|
155
|
-
with trusted publishing (OIDC, no stored token).
|
|
156
|
-
|
|
157
115
|
## Licence
|
|
158
116
|
|
|
159
117
|
Proprietary, (c) Previty GmbH. All rights reserved. See `LICENSE`.
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|