Skip to main content

Axial3D CLI

Project description

A3D CLI

Accessing the Axial3D apis from the command line

Requirements

  • Python 3.7, 3.8, 3.9

Install

pip install a3d-cli

Usage

Create an order:

a3dcli create --config_file config.json --dicom_location ./path_to_dicoms/ --order-type 3DPrint --notes notes --surgery 'Surgery' --patient-gender M --patient-birth-year 2001 --catalogue-item 101 --required-date '10-08-2021'

Update an order

a3dcli upload --config_file config.json --dicom_location ./path_to_dicoms/ --order_id 1000

View help:

a3dcli --help
usage: a3dcli [-h] --config_file CONFIG_FILE --order-type [ORDER_TYPES [ORDER_TYPES ...]] --catalogue-item-id [CATALOGUE_ITEM_ID] --surgery [SURGERY] --required-date [REQUIRED_DATE]
              --patient-gender [{M,F,U}] --patient-birth-year [BIRTH_YEAR] --notes [NOTES] [--base_url BASE_URL] [--verify] [--username USERNAME] [--password PASSWORD] [--order_id ORDER_ID] [--dicom_location DICOM_LOCATION] {create,upload}

Axial3D CLI (0.2.0)

positional arguments:
  {create,upload}
                        Create Order, Upload by order id

optional arguments:
  -h, --help            show this help message and exit
  --config_file CONFIG_FILE
                        a3dcli config file
  --order-type [ORDER_TYPES [ORDER_TYPES ...]]
                        Order Types
  --catalogue-item-id [CATALOGUE_ITEM_ID]
                        Catalogue Item
  --surgery [SURGERY]   Surgery
  --required-date [REQUIRED_DATE]
                        Required Date
  --patient-gender [{M,F,U}]
                        Gender
  --patient-birth-year [BIRTH_YEAR]
                        Gender
  --notes [NOTES]       Notes
  --base_url BASE_URL   Base url of axial3D API
  --verify
  --username USERNAME   axial3D account username
  --password PASSWORD   axial3D account password
  --order_id ORDER_ID   ID of the order
  --dicom_location DICOM_LOCATION
                        Path to DICOM files

Dev requirements

Build

poetry build

Testing

Unit tests

poetry run pytest

Integration tests

poetry run pytest --integration --integration-user USERNAME --integration-password PASSWORD --integration-url https://example.com

Build

poetry build

> Building a3d-cli (0.1.0)
> - Building sdist
> - Built a3d-cli-0.1.0.tar.gz
> - Building wheel
> - Built a3d_cli-0.1.0-py3-none-any.whl

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

a3d-cli-1.0.0.tar.gz (8.9 kB view details)

Uploaded Source

Built Distribution

a3d_cli-1.0.0-py3-none-any.whl (9.8 kB view details)

Uploaded Python 3

File details

Details for the file a3d-cli-1.0.0.tar.gz.

File metadata

  • Download URL: a3d-cli-1.0.0.tar.gz
  • Upload date:
  • Size: 8.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.10 CPython/3.8.12 Linux/5.4.92-flatcar

File hashes

Hashes for a3d-cli-1.0.0.tar.gz
Algorithm Hash digest
SHA256 0ab76a0345b6014e2a92b492f681c9009ca5545cf2a8aa495bbb91f8aad5cfe5
MD5 b39e98c89f624c05a038c8012e20469a
BLAKE2b-256 4b111d6b27b3ea0c96a2545449a13fcf47ddad82fafb62b923a1e2aea398bd52

See more details on using hashes here.

File details

Details for the file a3d_cli-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: a3d_cli-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 9.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.10 CPython/3.8.12 Linux/5.4.92-flatcar

File hashes

Hashes for a3d_cli-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1b7d36d30f8b9ae04a676334f4b12de22708e9ee2d0fe16cb563f028cfc0f3e6
MD5 22d8fc7b42753d400b9d89c51b0c5abe
BLAKE2b-256 c0a4d84b9400c8bdf87be6c6da92adaa93c7583e5d26265c4364f120610a09d1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page