Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
102f210
docs(claude): add SDLC Configuration block to CLAUDE.md
arne-aignx Apr 29, 2026
7fd545b
chore: TODO - add commit content
arne-aignx Apr 29, 2026
2930b91
chore(codegen): regenerate aignx.codegen client from openapi v1.5.0 […
arne-aignx Apr 29, 2026
bb0c6d0
feat(platform): add Documents resource for application version releas…
arne-aignx Apr 29, 2026
b0709d1
feat(application): add CLI version document {list,describe,download} …
arne-aignx Apr 29, 2026
88d9eaf
chore: bump SPEC dates and fix lint/test fallout from documents codeg…
arne-aignx Apr 29, 2026
cb39f03
fix(application): silence pyright unused-variable warnings in documen…
arne-aignx Apr 29, 2026
3d362a3
refactor(platform): simplify document download and address PR review …
arne-aignx Apr 29, 2026
634356a
refactor(platform): address SonarCloud findings on documents PR [PYSD…
arne-aignx Apr 29, 2026
0f86fb2
feat(platform): add Documents.read_content() for /content endpoint [P…
arne-aignx Apr 29, 2026
0e6d483
fix: test after model update
arne-aignx Apr 29, 2026
3ecdc45
test(application): cover document CLI error paths and JSON output [PY…
arne-aignx Apr 30, 2026
46f5e9b
refactor(platform): address SonarCloud findings on documents PR [PYSD…
arne-aignx Apr 30, 2026
c7897d8
fixup! refactor(platform): address SonarCloud findings on documents P…
arne-aignx Apr 30, 2026
8cf5263
chore: address review comments
arne-aignx Apr 30, 2026
7c9c5b4
Remove option to set file name for downloading release documents
arne-aignx May 4, 2026
febe479
chore: Address comments
arne-aignx May 5, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -1848,3 +1848,25 @@ ls $test_file
---

*This documentation provides comprehensive guidance for working with the Aignostics Python SDK. Each module has detailed CLAUDE.md files with implementation specifics, usage examples, and best practices.*

## SDLC Configuration

- **JIRA Project Key:** PYSDK
- **Atlassian Cloud ID:** fff788d2-8a2a-4c36-a884-dde2bb4a2b49
- **Ketryx Project:** Python SDK (KXPRJ2Q4PA8AADY975SFMKF276TYV75)

**Item type locations:**
- Change Requests: Ketryx Change Request (JIRA)
- Stakeholder Requirements: requirements/SHR-*.md (Git)
- Software Requirements: Requirement (JIRA) | requirements/SWR-*.md (Git, preferred)
- Risks: Risk (JIRA)
- Software Item Specs: Software Item Spec (JIRA) | specifications/SPEC-*.md (Git, preferred)
- Test Cases: tests/**/TC-*.feature (Git)

**Approval structure:**
- Ketryx Change Request: Product Manager → Engineering Tech Lead → Quality Managers → Risk Managers
- Software Requirement: Area Lead (BD) → Security Engineer → Regulatory Affairs Specialist → Engineer → Engineering Tech Lead → Product Manager
- Software Item Spec: Engineer → Engineering Tech Lead
- Risk: Quality Managers → Security Engineer → Product Managers → Tech Lead → Engineer → Engineering Tech Lead → Product Manager → Engineer
- Test Case: Engineer → Engineering Tech Lead
- Anomaly: Engineer → Engineering Tech Lead
107 changes: 104 additions & 3 deletions CLI_REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,7 @@ $ aignostics application [OPTIONS] COMMAND [ARGS]...
* `list`: List available applications.
* `dump-schemata`: Output the input schema of the application...
* `describe`: Describe application.
* `version`: Inspect application versions and their release documents.
* `run`: List, submit and manage application runs

### `aignostics application list`
Expand Down Expand Up @@ -204,6 +205,106 @@ $ aignostics application describe [OPTIONS] APPLICATION_ID
* `--format TEXT`: Output format: 'text' (default) or 'json' [default: text]
* `--help`: Show this message and exit.

### `aignostics application version`

Inspect application versions and their release documents.

**Usage**:

```console
$ aignostics application version [OPTIONS] COMMAND [ARGS]...
```

**Options**:

* `--help`: Show this message and exit.

**Commands**:

* `document`: List, describe, and download public release documents attached to an application version.

#### `aignostics application version document`

List, describe, and download public release documents attached to an application version (e.g. output schemas, model manuals).

**Usage**:

```console
$ aignostics application version document [OPTIONS] COMMAND [ARGS]...
```

**Options**:

* `--help`: Show this message and exit.

**Commands**:

* `list`: List public release documents attached to an application version.
* `describe`: Show metadata for a single public release document.
* `download`: Download a public release document to a local path.

##### `aignostics application version document list`

List public release documents attached to an application version.

**Usage**:

```console
$ aignostics application version document list [OPTIONS] APPLICATION_ID
```

**Arguments**:

* `APPLICATION_ID`: Id of application to list release documents for. [required]

**Options**:

* `--application-version TEXT`: Version of the application. If not provided, the latest version will be used.
* `--format TEXT`: Output format: 'text' (default) or 'json' [default: text]
* `--help`: Show this message and exit.

##### `aignostics application version document describe`

Show metadata for a single public release document.

**Usage**:

```console
$ aignostics application version document describe [OPTIONS] APPLICATION_ID DOCUMENT_NAME
```

**Arguments**:

* `APPLICATION_ID`: Id of application to describe release documents for. [required]
* `DOCUMENT_NAME`: Document filename (e.g. 'output_description.pdf'). [required]

**Options**:

* `--application-version TEXT`: Version of the application. If not provided, the latest version will be used.
* `--format TEXT`: Output format: 'text' (default) or 'json' [default: text]
* `--help`: Show this message and exit.

##### `aignostics application version document download`

Download a public release document to a local path.

**Usage**:

```console
$ aignostics application version document download [OPTIONS] APPLICATION_ID DOCUMENT_NAME
```

**Arguments**:

* `APPLICATION_ID`: Id of application to download release documents for. [required]
* `DOCUMENT_NAME`: Document filename (e.g. 'output_description.pdf'). [required]

**Options**:

* `--application-version TEXT`: Version of the application. If not provided, the latest version will be used.
* `--output PATH`: Destination directory. Defaults to the current working directory. [default: (<current-working-directory>)]
* `--help`: Show this message and exit.

### `aignostics application run`

List, submit and manage application runs
Expand Down Expand Up @@ -579,9 +680,9 @@ $ aignostics application run result download [OPTIONS] RUN_ID [DESTINATION_DIREC
* `--create-subdirectory-for-run / --no-create-subdirectory-for-run`: Create a subdirectory for the results of the run in the destination directory [default: create-subdirectory-for-run]
* `--create-subdirectory-per-item / --no-create-subdirectory-per-item`: Create a subdirectory per item in the destination directory [default: create-subdirectory-per-item]
* `--wait-for-completion / --no-wait-for-completion`: Wait for run completion and download results incrementally [default: wait-for-completion]
* `--qupath-project / --no-qupath-project`: Create a QuPath project referencing input slides and results.
The QuPath project will be created in a subfolder of the destination directory.
This option requires the QuPath extension for Launchpad: start the Launchpad with `uvx --with "aignostics" aignostics ...`
* `--qupath-project / --no-qupath-project`: Create a QuPath project referencing input slides and results.
The QuPath project will be created in a subfolder of the destination directory.
This option requires the QuPath extension for Launchpad: start the Launchpad with `uvx --with "aignostics" aignostics ...`
This options requires installation of the QuPath application: Run uvx --with "aignostics" aignostics qupath install [default: no-qupath-project]
* `--help`: Show this message and exit.

Expand Down
Loading
Loading