COMMAND LINE Interface TOOL

윌드빗 을 사용하는 가장 쉬운 방법은 윌드빗 의 Open API와 상호작용하는 Python으로 구현 된 CLI (명령 줄 도구)를 사용하는 것입니다.

wild-cli 란?

N3NCLOUD에서 제작한 윌드빗 공식 CLI Tool입니다. 윌드빗 의 데이터셋은 Python 3에서 구현 된 명령 줄 도구를 사용하여 액세스 할 수 있습니다.

윌드빗 은 DCAT표준을 이용하여 데이터 공개를 목적으로 데이터 포털을 구축하기위한 CKAN 기반 솔루션입니다. 윌드빗 은 다른 데이터 카탈로그 시스템과 데이터를 공유하기 위해 등록 된 데이터 셋을 표준 프로토콜을 이용하여 가장 효율적으로 공개합니다. 윌드빗 은 가장 호환성 좋은 표준 형식을 사용하며 글로벌 데이터 공유를 위한 최상의 솔루션입니다. 다음의 URL에서 Wildebeest Documents ( http://d3.n3ncloud.co.kr/wildebeest/1.0 ) 및 N3NCLOUD ( https://www.n3ncloud.co.kr/ ) 에 대한 자세한 정보를 얻을 수 있습니다.

_images/cli1.png

Installation

Python 3 및 패키지 관리자 pip 가 설치되어 있는지 확인하십시오 .

COMMAND LINE Interface TOOL인 wild-cli 를 설치하려면 다음 명령을 실행하십시오.

우리는 명령을 시작하기 위해 ‘wild’ 라는 단어를 사용합니다.

1
pip install wild

pip install wild (Mac/Linux의 설치 과정에서 문제가 발생한다면 pip install –user wild 를 수행해야 할 수도 있습니다). 루트 사용자를 통해 설치 한 경우 ( 예: sudo pip install wild ) 제대로 작동하지 않습니다.

이제 아래 예에 표시된대로 wild 명령을 사용할 수 있습니다.

wild 명령어를 실행했을때 wild: command not found 에러가 발생한다면, 파이썬 바이너리 경로에 있는지 확인해야 합니다. pip uninstall wild 을 수행 하고 바이너리가 어디에 있는지 확인하여 wild 가 설치된 위치를 확인해야 합니다. Linux에 로컬 사용자 설치의 경우 기본 위치는 ~/.local/bin 입니다. Windows에서 기본 위치는 $PYTHON_HOME/Scripts 입니다.

Important

Python 2는 지원하지 않습니다. 문제가 발생한다면 보고하기 전에 Python 3을 사용하고 있는지 확인하십시오.

API credentials

wild-cli를 사용하려면 사이트에서 윌드빗 계정에 가입하십시오. 그런 다음 사용자 프로필 ( https://[site url]/user/<username> )로 이동하여 ‘관리’를 선택하고 ‘API 키 재생성’을 클릭하십시오. 그러면 API 키가 다시 생성되고 계정 페이지로 돌아와 페이지 왼쪽 하단에서 API 키를 찾을 수 있습니다. 그런 다음 윌드빗 서버 URL과 API 키를 envexport 해야 합니다. 아래의 예를 참고 하십시오.

Environment:

1
2
export WB_SERVER_URL=http://[your-site-url]
export WB_API_KEY=[your-api-key-string]

Example:

1
2
export WB_SERVER_URL=http://127.0.0.1
export WB_API_KEY=e2806328-af09-41b2-b389-3fd78645fdcb

Commands

wild-cli 는 다음 명령을 지원합니다.

1
2
3
$ wild organizations {list | show | datasets}
$ wild datasets {list | show | search | resources | download}
$ wild resource {show | download}

이러한 각 명령 사용에 대한 자세한 내용은 아래를 참조하십시오.

Organizations

이 명령은 Wildebeest Organizations에 대해 다음 명령을 지원합니다.

1
2
3
4
5
6
7
8
9
usage: wild organizations [OPTIONS] COMMAND

optional arguments:
  -h, --help            show this help message and exit

commands:
  list                  List available organizations
  show                  Show the detail of a organization
  datasets              List datasets of a organization

List organizations

1
2
3
4
usage: wild organizations list [-h]

optional arguments:
  -h, --help            show this help message and exit

Example:

1
2
$ wild organizations list
$ wild o l

Show organization detail

1
2
3
4
5
usage: wild organizations show [-h] [organization-name]

optional arguments:
  -h, --help            show this help message and exit
  organization-name     Organizations Name (use "wild organizations list" to show options)

Example:

1
2
$ wild organization show n3ncloud
$ wild o s n3ncloud

List datasets

1
2
3
4
5
6
usage: wild organizations datasets [-h] [organization-name]

optional arguments:
  -h, --help            show this help message and exit
  organization-name     Organizations Name (use "wild organizations list" to show options)
  -p, --page            Page number for results paging. Page size is 20 by default

Examples:

1
2
$ wild organizations datasets n3ncloud --page 2
$ wild o d n3ncloud -p 2

Datasets

이 명령은 Wildebeest 데이터 세트에 대해 다음 명령을 지원합니다.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
usage: wild datasets  [OPTIONS] COMMAND

optional arguments:
  -h, --help            show this help message and exit

commands:
  list                  List available datasets
  show                  Show the detail of a dataset
  search                Search datasets by query or keyword
  resources             List the resources of a dataset
  download              Download resource files of a dataset

List datasets

1
2
3
4
5
usage: wild datasets list [-h] [-p PAGE]

optional arguments:
  -h, --help            show this help message and exit
  -p PAGE, --page PAGE  Page number for results paging. Page size is 20 by default

Example:

1
2
$ wild datasets list
$ wild d l -p 2

Show dataset detail

1
2
3
4
5
usage: wild datasets show [-h] [dataset]

optional arguments:
  -h, --help            show this help message and exit
  dataset               Dataset Id (use "wild datasets list" to show options)

Example:

1
2
$ wild datasets show 01631b54-16a3-4a84-8dac-3e8d142e12b9
$ wild d sh 01631b54-16a3-4a84-8dac-3e8d142e12b9

Search specific datasets

1
2
3
4
5
6
usage: wild datasets search [-h] [-p PAGE] [query]

optional arguments:
  -h, --help            show this help message and exit
  -p PAGE, --page PAGE  Page number for results paging. Page size is 20 by default
  query                 Query string what you want to find in datasets

Example:

1
2
$ wild datasets search 'cloud platfrom'
$ wild d s 'cloud platform' -p 2

List dataset resources

1
2
3
4
5
usage: wild datasets resources [-h] [dataset]

optional arguments:
  -h, --help            show this help message and exit
  dataset               Dataset Id (use "wild datasets list" to show options)

Example:

1
2
$ wild datasets resources 01631b54-16a3-4a84-8dac-3e8d142e12b9
$ wild d r 01631b54-16a3-4a84-8dac-3e8d142e12b9

Download dataset resources

1
2
3
4
5
6
7
usage: wild datasets download [-h] [-f FILE_NAME] [-p PATH] [-w] [--unzip]
                              [-o] [-q]
                              [dataset]

optional arguments:
  -h, --help            show this help message and exit
  dataset               Dataset Id (use "wild datasets list" to show options)

Examples:

1
2
$ wild datasets download 01631b54-16a3-4a84-8dac-3e8d142e12b9
$ wild d d 01631b54-16a3-4a84-8dac-3e8d142e12b9

Resource

이 명령은 Wildebeest 리소스에 대해 다음 명령을 지원합니다.

1
2
3
4
5
6
7
8
usage: wild resource  [OPTIONS] COMMAND

optional arguments:
  -h, --help            show this help message and exit

commands:
  show                  List available kernels
  download              Initialize metadata file for a kernel

Show resource detail

1
2
3
4
5
usage: wild resource show [-h] [resource]

optional arguments:
  -h, --help            show this help message and exit
  resource              Resource Id (use "wild datasets resources" to show options)

Example:

1
2
$ wild resource show 13325edd-3d64-4e2a-a7e3-30e84ae017ab
$ wild r s 13325edd-3d64-4e2a-a7e3-30e84ae017ab

Download a resource

1
2
3
4
5
usage: wild resource download [resource]

optional arguments:
  -h, --help            show this help message and exit
  resource              Resource Id (use "wild datasets resources" to show options)

Example:

1
2
$ wild resource download 13325edd-3d64-4e2a-a7e3-30e84ae017ab
$ wild r d 13325edd-3d64-4e2a-a7e3-30e84ae017ab

License

The wild(Wildebeest) CLI is released under the [Apache 2.0 license].