Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/edgarrmondragon/tap-bitso
Singer tap for the Bitso API
https://github.com/edgarrmondragon/tap-bitso
bitso meltano-sdk singer-io singer-tap
Last synced: 22 days ago
JSON representation
Singer tap for the Bitso API
- Host: GitHub
- URL: https://github.com/edgarrmondragon/tap-bitso
- Owner: edgarrmondragon
- License: apache-2.0
- Created: 2021-07-12T00:59:35.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-02T06:10:48.000Z (about 1 month ago)
- Last Synced: 2024-10-02T20:35:12.352Z (about 1 month ago)
- Topics: bitso, meltano-sdk, singer-io, singer-tap
- Language: Python
- Homepage: http://pypi.org/p/tap-bitso
- Size: 812 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tap-bitso
⚠️ Warning: this project is under active development, essential features are still missing and implementation subject to change. ⚠️
`tap-bitso` is a Singer tap for the [Bitso API](https://bitso.com/api_info).
Built with the Meltano [SDK](https://gitlab.com/meltano/sdk) for Singer Taps.
## Installation
```bash
pipx install git+https://github.com/edgarrmondragon/tap-bitso.git
```
## Configuration
### Accepted Config Options
A full list of supported settings and capabilities for this
tap is available by running:
```bash
tap-bitso --about
```
| Field | Description | Type | Required | Default |
|------------|-------------------------|----------------|----------|-------------------------|
| `key` | Bitso API Key | `string` | yes | |
| `secret` | Bitso API Secret | `string` | yes | |
| `base_url` | Bitso API URL | `string` | no | `https://api.bitso.com` |
| `books` | Tickers to get data for | `list(string)` | no | `["btc_mxn"]` |
### Source Authentication and Authorization
This tap handles the [digest access authentication for the Bitso API](https://docs.bitso.com/bitso-api/docs/authentication).
## Usage
You can easily run `tap-bitso` by itself or in a pipeline using [Meltano](www.meltano.com).
### Executing the Tap Directly
```bash
tap-bitso --version
tap-bitso --help
tap-bitso --config CONFIG --discover > ./catalog.json
```
## Developer Resources
### Initialize your Development Environment
```bash
pipx install poetry
poetry install
```
### Testing with [Meltano](https://www.meltano.com)
_**Note:** This tap will work in any Singer environment and does not require Meltano.
Examples here are for convenience and to streamline end-to-end orchestration scenarios._
Next, install Meltano (if you haven't already) and any needed plugins:
```bash
# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-bitso
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# Test invocation:
meltano invoke tap-bitso --version
# OR run a test `elt` pipeline:
meltano elt tap-bitso target-sqlite
```
### SDK Dev Guide
See the [dev guide](https://sdk.meltano.com/en/latest/dev_guide.html) for more instructions on how to use the SDK to
develop your own taps and targets.