1  # Crypto Market Extractor Source
 2  
 3  This is the repository for the Crypto Market Extractor source connector, written in Python.
 4  
 5  ## Usage
 6  
 7  This connector fetch coins value on API.
 8  
 9  The Supported API:
10  * CoinGecko
11  
12  ### Configuration
13  
14  The connector takes the following input:
15  
16  ```yaml
17  coins:
18    type: array
19    name: coins
20    description: List of coin to fetch the price. List available at coingecko api under `/coins/list`
21    items:
22      type: string
23  ```
24  
25  ### Output
26  
27  This connector will return a list of coin for each chain with the following models
28  
29  * `name`: Name of the coin.
30  * `price`: Price in USD of the coin
31  * `date`: Date of the sync.
32  
33  ## Local development
34  
35  ### Prerequisites
36  
37  #### Activate Virtual Environment and install dependencies
38  From this connector directory, create a virtual environment:
39  ```
40  python -m venv .venv
41  ```
42  ```
43  source .venv/bin/activate
44  pip install -r requirements.txt
45  ```
46  
47  ### Locally running the connector
48  ```
49  python main.py spec
50  python main.py check --config sample_files/config-example.json
51  python main.py discover --config sample_files/config-example.json
52  python main.py read --config sample_files/config-example.json --catalog sample_files/configured_catalog.json
53  ```
54  
55  ### Locally running the connector docker image
56  
57  ```bash
58  docker build -t airbyte/crypto-market-extractor:dev .
59  # Running the spec command against your patched connector
60  docker run airbyte/crypto-market-extractor:dev spec
61  ````
62  
63  #### Run
64  Then run any of the connector commands as follows:
65  ```
66  docker run --rm airbyte/crypto-market-extractor:dev spec
67  docker run --rm -v $(pwd)/sample_files:/sample_files airbyte/crypto-market-extractor:dev check --config /sample_files/coin_list.json
68  docker run --rm -v $(pwd)/sample_files:/sample_files airbyte/crypto-market-extractor:dev discover --config /sample_files/coin_list.json
69  docker run --rm -v $(pwd)/sample_files:/sample_files -v $(pwd)/sample_files:/sample_files airbyte/crypto-market-extractor:dev read --config /sample_files/coin_list.json --catalog /sample_files/configured_catalog.json