Skip to main content

A command line tool to interact with Cortal Insight API

Project description

Cortal Insight CLI Tool

The Cortal Insight CLI Tool is a command-line interface for interacting with the Cortal Insight API, allowing you to manage datasets conveniently through your terminal.

Setup

Documentation

Dashboard documentation Docs / API

Installation

pip install cortalinsight

or

git clone https://github.com/cortal-insight/cortal-insight-python-client

cd path/to/cortal-insight-python-client

pip install .

Get started

  1. Create your account Sign up in the Cortal Insight dashboard

  2. Request your API key for the service

  3. Set your API key

cortalinsight setup "YOUR_API_KEY_HERE"

Usage

  1. Creating a dataset
cortalinsight create_dataset <dataset_name>
  1. List all datasets
cortalinsight list_datasets
  1. Get dataset by id
cortalinsight get_dataset <dataset_id>
  1. Delete dataset by id
cortalinsight delete_dataset <dataset_id>
  1. Upload images from directory to dataset
cortalinsight upload_images_from_dir <dataset_id>  <directory_containing_images>
  1. Upload zip of images to dataset
cortalinsight upload_zip <dataset_id>  <zip_containing_images>
  1. Upload metadata to dataset
cortalinsight upload_metadata <dataset_id>  <file_containing_metadata>
  1. Update metadata to dataset
cortalinsight update_metadata <dataset_id>  <file_containing_metadata>
  1. Validate metadata to dataset
cortalinsight validate_metadata  <dfile_containing_metadata>

This project is licensed under the MIT License - see the LICENSE file for details.

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

cortalinsight-0.1.6.tar.gz (12.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cortalinsight-0.1.6-py3-none-any.whl (13.3 kB view details)

Uploaded Python 3

File details

Details for the file cortalinsight-0.1.6.tar.gz.

File metadata

  • Download URL: cortalinsight-0.1.6.tar.gz
  • Upload date:
  • Size: 12.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.4

File hashes

Hashes for cortalinsight-0.1.6.tar.gz
Algorithm Hash digest
SHA256 4c8f5fdef0b40996aae4337bcea2345290445f9560c0f23cc960d572d219fca1
MD5 5eedf696cffdd7299c90d01ab94d29ee
BLAKE2b-256 bb484fdc15da67a84cf83e94b9bd4e09a77998f2f639815bf5b098c807af5dbd

See more details on using hashes here.

File details

Details for the file cortalinsight-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: cortalinsight-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 13.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.4

File hashes

Hashes for cortalinsight-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 4cb4297481bf5893f4d187f6862cfe6485849fe24dd854a8c3c38b94780b3c83
MD5 32b3b3ab6c462706a8023fea8c2ce634
BLAKE2b-256 a59a9a507689e96d4c51cafe82ce2341bdb1d7ab5910a7a48452e602b4c077c2

See more details on using hashes here.

Supported by

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