12. aptcli¶

aptcli is a command line tool for Aperture user tasks.

usage: aptcli [-h] -c CONFIG {project,dataset,file,measurement} ...

12.1. Positional Arguments¶

subparser

Possible choices: project, dataset, file, measurement

Aperture command line interface

12.2. Named Arguments¶

-c, --config: Aperture cli configuration file

12.3. Sub-commands:¶

12.3.1. project¶

Project administration

aptcli project [-h] {create,list,update,delete} ...

12.3.1.1. project¶

project: Possible choices: create, list, update, delete

12.3.1.2. Sub-commands:¶

12.3.1.2.1. create¶

Create project

aptcli project create [-h] --name NAME --description DESCRIPTION --owner OWNER
                      --authgroup AUTHGROUP --sftp_host SFTP_HOST --sftp_port
                      SFTP_PORT --sftp_user SFTP_USER
                      (--sftp_password SFTP_PASSWORD | --sftp_key SFTP_KEY)
                      --sftp_path SFTP_PATH
                      [--deid_project_id DEID_PROJECT_ID]

12.3.1.2.1.1. Named Arguments¶

--name: project name
--description: project description
--owner: project owner (e-mail address)
--authgroup: project authgroup
--sftp_host: sftp host
--sftp_port: sftp port
--sftp_user: sftp user
--sftp_password: sftp password
--sftp_key: sftp key
--sftp_path: sftp path
--deid_project_id: de-identification project identifier

12.3.1.2.2. list¶

List projects

aptcli project list [-h]

12.3.1.2.3. update¶

Update project

aptcli project update [-h] --id ID --name NAME --description DESCRIPTION
                      --owner OWNER --authgroup AUTHGROUP --sftp_host
                      SFTP_HOST --sftp_port SFTP_PORT --sftp_user SFTP_USER
                      (--sftp_password SFTP_PASSWORD | --sftp_key SFTP_KEY)
                      --sftp_path SFTP_PATH
                      [--deid_project_id DEID_PROJECT_ID]

12.3.1.2.3.1. Named Arguments¶

--id: project identifier
--name: project name
--description: project description
--owner: project owner (e-mail address)
--authgroup: project authgroup
--sftp_host: sftp host
--sftp_port: sftp port
--sftp_user: sftp user
--sftp_password: sftp password
--sftp_key: sftp key
--sftp_path: sftp path
--deid_project_id: de-identification project identifier

12.3.1.2.4. delete¶

Delete project

aptcli project delete [-h] --id ID

12.3.1.2.4.1. Named Arguments¶

--id: project id

12.3.2. dataset¶

Dataset import/export

aptcli dataset [-h] {import,list} ...

12.3.2.1. dataset¶

dataset: Possible choices: import, list

12.3.2.2. Sub-commands:¶

12.3.2.2.1. import¶

Import dataset

aptcli dataset import [-h] --project_name PROJECT_NAME --csv CSV --def DEF
                      [--ephemeral] [--external]

12.3.2.2.1.1. Named Arguments¶

--project_name

project name

--csv

name of csv file

--def

name of definition file

--ephemeral

delete dataset after export

Default: False

--external

use external dataset import

Default: False

12.3.2.2.2. list¶

List datasets

aptcli dataset list [-h] --project_id PROJECT_ID

12.3.2.2.2.1. Named Arguments¶

--project_id: project identifier

12.3.3. file¶

File import/export

aptcli file [-h] {import,list} ...

12.3.3.1. file¶

file: Possible choices: import, list

12.3.3.2. Sub-commands:¶

12.3.3.2.1. import¶

Import file

aptcli file import [-h] --project_name PROJECT_NAME --unstructured
                   UNSTRUCTURED [--ephemeral]

12.3.3.2.1.1. Named Arguments¶

--project_name

project name

--unstructured

name of unstructured file

--ephemeral

delete file after export

Default: False

12.3.3.2.2. list¶

List files

aptcli file list [-h] --project_id PROJECT_ID

12.3.3.2.2.1. Named Arguments¶

--project_id: project identifier

12.3.4. measurement¶

Measurement

aptcli measurement [-h]