Metadata-Version: 2.1
Name: isic-cli
Version: 10.0.0
Home-page: https://github.com/ImageMarkup/isic-cli
Author: Kitware, Inc.
Author-email: kitware@kitware.com
License: Apache 2.0
Project-URL: Bug Reports, https://github.com/ImageMarkup/isic-cli/issues
Project-URL: Source, https://github.com/ImageMarkup/isic-cli
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click>=8
Requires-Dist: django-s3-file-field-client>=1.0.0
Requires-Dist: girder-cli-oauth-client<1.0.0
Requires-Dist: humanize
Requires-Dist: isic-metadata>=1.2.0
Requires-Dist: more-itertools
Requires-Dist: packaging
Requires-Dist: requests
Requires-Dist: retryable-requests
Requires-Dist: rich
Requires-Dist: sentry-sdk
Requires-Dist: tenacity
Provides-Extra: dev
Requires-Dist: ipython; extra == "dev"
Requires-Dist: tox; extra == "dev"

# isic-cli

The official command line tool for interacting with the [ISIC Archive](https://isic-archive.com).

## Installation
- Download the [latest isic-cli release](https://github.com/ImageMarkup/isic-cli/releases/latest).
- Extract the executable to a location where it can be invoked from the command line.

If running on macOS, you may need to [add the executable to the list of trusted software](https://support.apple.com/guide/mac-help/apple-cant-check-app-for-malicious-software-mchleab3a043/mac) to launch isic-cli in the same way you would any other registered app.

## Common use cases

Note: `isic` will be `isic.exe` on Windows.

### Downloading images

``` sh
isic image download images/  # downloads the entire archive, images and metadata, to images/

# optionally filter the results
isic image download --search 'diagnosis:"basal cell carcinoma"' images/
isic image download --search 'age_approx:[5 TO 25] AND sex:male' images/
```


### Downloading metadata

``` sh
isic metadata download  # downloads the entire archive metadata to a csv

# find a collection to filter by
isic collection list  # grab the ID for the 2020 Challenge training set (70)
isic metadata download --collections 70
```
