Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/edgarrmondragon/tap-geekbot
Singer tap for Geekbot
https://github.com/edgarrmondragon/tap-geekbot
geekbot meltano singer-io singer-sdk
Last synced: 3 months ago
JSON representation
Singer tap for Geekbot
- Host: GitHub
- URL: https://github.com/edgarrmondragon/tap-geekbot
- Owner: edgarrmondragon
- License: apache-2.0
- Created: 2023-08-16T02:46:21.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-07T16:00:57.000Z (3 months ago)
- Last Synced: 2024-10-07T16:07:39.189Z (3 months ago)
- Topics: geekbot, meltano, singer-io, singer-sdk
- Language: Python
- Homepage: https://pypi.org/p/tap-geekbot
- Size: 398 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `tap-geekbot`
Singer tap for [Geekbot](https://geekbot.com/).
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-geekbot --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-geekbot` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Tap Directly
```bash
tap-geekbot --version
tap-geekbot --help
tap-geekbot --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-geekbot` CLI interface directly using `poetry run`:
```bash
poetry run tap-geekbot --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-geekbot
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# Test invocation:
meltano invoke tap-geekbot --version
# OR run a test `elt` pipeline:
meltano elt tap-geekbot 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.