Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/edgarrmondragon/tap-readthedocs
A singer.io tap for readthedocs.io, bult with the Meltano SDK
https://github.com/edgarrmondragon/tap-readthedocs
meltano-sdk readthedocs singer-io singer-tap
Last synced: 22 days ago
JSON representation
A singer.io tap for readthedocs.io, bult with the Meltano SDK
- Host: GitHub
- URL: https://github.com/edgarrmondragon/tap-readthedocs
- Owner: edgarrmondragon
- License: apache-2.0
- Created: 2021-12-22T23:40:56.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-07T22:37:09.000Z (29 days ago)
- Last Synced: 2024-10-07T22:50:11.141Z (29 days ago)
- Topics: meltano-sdk, readthedocs, singer-io, singer-tap
- Language: Python
- Homepage: https://pypi.org/p/tap-readthedocs
- Size: 565 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tap-readthedocs
Singer Tap for [**Read the Docs**](https://docs.readthedocs.io). Built with the [Meltano Singer SDK](https://sdk.meltano.com).
## Capabilities
* `catalog`
* `state`
* `discover`
* `about`
* `stream-maps`
## Settings
| Setting| Required | Default | Description |
|:-------|:--------:|:-------:|:------------|
| token | True | None | |
| include_business_streams | False | False | Whether to include streams available only to ReadTheDocs for Business accounts |
A full list of supported settings and capabilities is available by running: `tap-readthedocs --about`
## Installation
```bash
pipx install tap-readthedocs
```
### Source Authentication and Authorization
Generate a token: https://readthedocs.org/accounts/tokens/.
## Usage
You can easily run `tap-readthedocs` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Tap Directly
```bash
tap-readthedocs --version
tap-readthedocs --help
tap-readthedocs --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 test:integration
```
You can also test the `tap-readthedocs` 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
```
2. Check that the extractor is working properly
```bash
meltano invoke tap-readthedocs --version
```
3. Execute an ELT pipeline
```bash
meltano run tap-readthedocs 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.