# 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>
```
2. List all datasets
```
cortalinsight list_datasets
```
3. Get dataset by id
```
cortalinsight get_dataset <dataset_id>
```
4. Delete dataset by id
```
cortalinsight delete_dataset <dataset_id>
```
5. Upload images from directory to dataset
```
cortalinsight upload_images_from_dir <dataset_id> <directory_containing_images>
```
6. Upload zip of images to dataset
```
cortalinsight upload_zip <dataset_id> <zip_containing_images>
```
7. Upload metadata to dataset
```
cortalinsight upload_metadata <dataset_id> <file_containing_metadata>
```
8. Update metadata to dataset
```
cortalinsight update_metadata <dataset_id> <file_containing_metadata>
```
9. Validate metadata to dataset
```
cortalinsight validate_metadata <dfile_containing_metadata>
```
This project is licensed under the MIT License - see the LICENSE file for details.
Raw data
{
"_id": null,
"home_page": "http://cortalinsight.com",
"name": "cortalinsight",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "cortal insight cli api",
"author": "Preetham",
"author_email": "developer@cortalinsight.com",
"download_url": "https://files.pythonhosted.org/packages/3d/24/139e0bbfcd2b7cc19191c3452eac8bcdae83719d79f7e23b1da9b573403f/cortalinsight-0.1.5.tar.gz",
"platform": null,
"description": "# Cortal Insight CLI Tool\n\nThe 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.\n\n\n## Setup\n\n## Documentation\nDashboard documentation\nDocs / API \n\n## Installation \n```\npip install cortalinsight\n```\n\nor \n\n```\ngit clone https://github.com/cortal-insight/cortal-insight-python-client\n\ncd path/to/cortal-insight-python-client\n\npip install .\n```\n## Get started\n\n1. Create your account\nSign up in the Cortal Insight dashboard\n\n2. Request your API key for the service\n\n3. Set your API key \n```\ncortalinsight setup \"YOUR_API_KEY_HERE\"\n```\n\n## Usage\n\n1. Creating a dataset\n\n```\ncortalinsight create_dataset <dataset_name>\n```\n\n2. List all datasets\n```\ncortalinsight list_datasets\n```\n\n3. Get dataset by id\n```\ncortalinsight get_dataset <dataset_id>\n```\n\n4. Delete dataset by id\n```\ncortalinsight delete_dataset <dataset_id>\n```\n\n5. Upload images from directory to dataset\n```\ncortalinsight upload_images_from_dir <dataset_id> <directory_containing_images>\n```\n\n6. Upload zip of images to dataset\n```\ncortalinsight upload_zip <dataset_id> <zip_containing_images>\n```\n \n7. Upload metadata to dataset\n```\ncortalinsight upload_metadata <dataset_id> <file_containing_metadata>\n```\n \n8. Update metadata to dataset\n```\ncortalinsight update_metadata <dataset_id> <file_containing_metadata>\n```\n \n9. Validate metadata to dataset\n```\ncortalinsight validate_metadata <dfile_containing_metadata>\n```\n\n\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n",
"bugtrack_url": null,
"license": null,
"summary": "A command line tool to interact with Cortal Insight API",
"version": "0.1.5",
"project_urls": {
"Homepage": "http://cortalinsight.com",
"Source Code": "https://github.com/cortal-insight/cortal-insight-python-client"
},
"split_keywords": [
"cortal",
"insight",
"cli",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "afeb1782deb6ec4e7d2f80c41244263e3db3acfbca67ffd39d677f772fc9fd55",
"md5": "9425f7c808289bdb1d335a468f12e8e3",
"sha256": "895a37cec085ca0283c8f16a8edf4fcf561b45375e091d51ac98cee79825e2a8"
},
"downloads": -1,
"filename": "cortalinsight-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9425f7c808289bdb1d335a468f12e8e3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10948,
"upload_time": "2024-10-17T02:06:11",
"upload_time_iso_8601": "2024-10-17T02:06:11.758250Z",
"url": "https://files.pythonhosted.org/packages/af/eb/1782deb6ec4e7d2f80c41244263e3db3acfbca67ffd39d677f772fc9fd55/cortalinsight-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3d24139e0bbfcd2b7cc19191c3452eac8bcdae83719d79f7e23b1da9b573403f",
"md5": "eb1c97edb64769634b5ef3f569716ed5",
"sha256": "b710127d7a3e5c73528bf32624d880e0e0121be95dfdb57061b4cc2d1ed2ffb7"
},
"downloads": -1,
"filename": "cortalinsight-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "eb1c97edb64769634b5ef3f569716ed5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10370,
"upload_time": "2024-10-17T02:06:13",
"upload_time_iso_8601": "2024-10-17T02:06:13.573478Z",
"url": "https://files.pythonhosted.org/packages/3d/24/139e0bbfcd2b7cc19191c3452eac8bcdae83719d79f7e23b1da9b573403f/cortalinsight-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-17 02:06:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cortal-insight",
"github_project": "cortal-insight-python-client",
"github_not_found": true,
"lcname": "cortalinsight"
}
JSON
