Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/reservoir-data/tap-readme
Singer tap for ReadMe.com
https://github.com/reservoir-data/tap-readme
api-documentation elt meltano singer-tap
Last synced: 7 days ago
JSON representation
Singer tap for ReadMe.com
- Host: GitHub
- URL: https://github.com/reservoir-data/tap-readme
- Owner: reservoir-data
- License: apache-2.0
- Created: 2024-02-05T21:56:01.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-12-17T00:06:39.000Z (17 days ago)
- Last Synced: 2024-12-22T02:41:14.164Z (12 days ago)
- Topics: api-documentation, elt, meltano, singer-tap
- Language: Python
- Homepage: https://pypi.org/p/tap-readme
- Size: 78.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# tap-readme
Singer tap for ReadMe.com.
Built with the [Meltano Singer SDK](https://sdk.meltano.com).
## Capabilities
* `catalog`
* `state`
* `discover`
* `about`
* `stream-maps`
* `schema-flattening`
* `batch`
## Settings
| Setting | Required | Default | Description |
|:--------------------|:--------:|:-------:|:------------|
| api_key | True | None | API Key for ReadMe.com |
| stream_maps | False | None | Config object for stream maps capability. For more information check out [Stream Maps](https://sdk.meltano.com/en/latest/stream_maps.html). |
| stream_map_config | False | None | User-defined config values to be used within map expressions. |
| faker_config | False | None | Config for the [`Faker`](https://faker.readthedocs.io/en/master/) instance variable `fake` used within map expressions. Only applicable if the plugin specifies `faker` as an addtional dependency (through the `singer-sdk` `faker` extra or directly). |
| flattening_enabled | False | None | 'True' to enable schema flattening and automatically expand nested properties. |
| flattening_max_depth| False | None | The max depth to flatten schemas. |
| batch_config | False | None | |
A full list of supported settings and capabilities is available by running: `tap-readme --about`
## Supported Python Versions
* 3.9
* 3.10
* 3.11
* 3.12
* 3.13
### Source Authentication and Authorization
Follow the [official authentication instructions](https://docs.readme.com/main/reference/intro/authentication) to get an API Key.
## Usage
You can easily run `tap-readme` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Tap Directly
```bash
tap-readme --version
tap-readme --help
tap-readme --config CONFIG --discover > ./catalog.json
```
## Developer Resources
### Initialize your Development Environment
```bash
pipx install hatch
```
### Create and Run Tests
Run integration tests:
```bash
hatch run tests:integration
```
You can also test the `tap-tap-readme` CLI interface directly:
```bash
hatch run sync:console -- --about --format=json
```
### 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. Go ahead and [install Meltano](https://docs.meltano.com/getting-started/installation/) if you haven't already.
1. Install all plugins
```bash
meltano install
```
1. Check that the extractor is working properly
```bash
meltano invoke tap-tap-readme --version
```
1. Execute an ELT pipeline
```bash
meltano run tap-tap-readme 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.