https://github.com/reservoir-data/tap-pomelo
Singer tap for Pomelo, built with the Singer SDK
https://github.com/reservoir-data/tap-pomelo
elt fintech-api meltano singer-tap
Last synced: 2 months ago
JSON representation
Singer tap for Pomelo, built with the Singer SDK
- Host: GitHub
- URL: https://github.com/reservoir-data/tap-pomelo
- Owner: reservoir-data
- License: apache-2.0
- Created: 2023-02-03T01:38:26.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-16T22:28:40.000Z (2 months ago)
- Last Synced: 2025-02-16T23:25:13.664Z (2 months ago)
- Topics: elt, fintech-api, meltano, singer-tap
- Language: Python
- Homepage:
- Size: 413 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# tap-pomelo
Singer tap for [Pomelo](https://pomelo.la/mx/).
Built with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.
## Capabilities
* `catalog`
* `state`
* `discover`
* `about`
* `stream-maps`
## Settings
- [ ] `Developer TODO:` Declare tap settings here.
A full list of supported settings and capabilities is available by running: `tap-pomelo --about`
### Source Authentication and Authorization
- [ ] `Developer TODO:` If your tap requires special access on the source system, or any special authentication requirements, provide those here.
## Usage
You can easily run `tap-pomelo` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Tap Directly
```bash
tap-pomelo --version
tap-pomelo --help
tap-pomelo --config CONFIG --discover > ./catalog.json
```
## Developer Resources
- [ ] `Developer TODO:` As a first step, scan the entire project for the text "`TODO:`" and complete any recommended steps, deleting the "TODO" references once completed.
### Initialize your Development Environment
```bash
pipx install poetry
poetry install
```
### Create and Run Tests
Create tests within the `tests` subfolder and then run:
```bash
poetry run pytest
```
You can also test the `tap-pomelo` CLI interface directly using `poetry run`:
```bash
poetry run tap-pomelo --help
```
### 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._
Your project comes with a custom `meltano.yml` project file already created. Open the `meltano.yml` and follow any _"TODO"_ items listed in
the file.
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-pomelo
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# Test invocation:
meltano invoke tap-pomelo --version
# OR run a test `elt` pipeline:
meltano elt tap-pomelo target-jsonl
```
### 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.