| Name | tap-readthedocs JSON |
| Version |
0.5.15
JSON |
| download |
| home_page | None |
| Summary | Singer tap for ReadTheDocs, built with the Meltano SDK for Singer Taps. |
| upload_time | 2025-10-22 01:01:46 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
elt
readthedocs
singer.io
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align="center">
# tap-readthedocs
<div>
<a href="https://results.pre-commit.ci/latest/github/reservoir-data/tap-readthedocs/main">
<img alt="pre-commit.ci status" src="https://results.pre-commit.ci/badge/github/reservoir-data/tap-readthedocs/main.svg"/>
</a>
<a href="https://github.com/astral-sh/ruff">
<img alt="Ruff" style="max-width:100%;" src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json">
</a>
<a href="https://github.com/pypa/hatch">
<img alt="Hatch project" src="https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg"/>
</a>
<a href="https://github.com/reservoir-data/tap-readthedocs/blob/main/LICENSE">
<img alt="License" src="https://img.shields.io/github/license/reservoir-data/tap-readthedocs"/>
</a>
<a href="https://github.com/reservoir-data/tap-readthedocs/">
<img alt="PyPI" src="https://img.shields.io/pypi/pyversions/tap-readthedocs"/>
</a>
</div>
Singer Tap for [**Read the Docs**](https://docs.readthedocs.io). Built with the [Meltano Singer SDK](https://sdk.meltano.com).
</div>
## 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "tap-readthedocs",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Edgar Ram\u00edrez-Mondrag\u00f3n <edgarrm358@gmail.com>",
"keywords": "ELT, ReadTheDocs, singer.io",
"author": null,
"author_email": "Edgar Ram\u00edrez-Mondrag\u00f3n <edgarrm358@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/fd/30/f61b037136ddb63550c55d53503d7c275360abc7a71fc5f7bc2a2b36b56a/tap_readthedocs-0.5.15.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n# tap-readthedocs\n\n<div>\n <a href=\"https://results.pre-commit.ci/latest/github/reservoir-data/tap-readthedocs/main\">\n <img alt=\"pre-commit.ci status\" src=\"https://results.pre-commit.ci/badge/github/reservoir-data/tap-readthedocs/main.svg\"/>\n </a>\n <a href=\"https://github.com/astral-sh/ruff\">\n <img alt=\"Ruff\" style=\"max-width:100%;\" src=\"https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json\">\n </a>\n <a href=\"https://github.com/pypa/hatch\">\n <img alt=\"Hatch project\" src=\"https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg\"/>\n </a>\n <a href=\"https://github.com/reservoir-data/tap-readthedocs/blob/main/LICENSE\">\n <img alt=\"License\" src=\"https://img.shields.io/github/license/reservoir-data/tap-readthedocs\"/>\n </a>\n <a href=\"https://github.com/reservoir-data/tap-readthedocs/\">\n <img alt=\"PyPI\" src=\"https://img.shields.io/pypi/pyversions/tap-readthedocs\"/>\n </a>\n</div>\n\nSinger Tap for [**Read the Docs**](https://docs.readthedocs.io). Built with the [Meltano Singer SDK](https://sdk.meltano.com).\n\n</div>\n\n## Capabilities\n\n* `catalog`\n* `state`\n* `discover`\n* `about`\n* `stream-maps`\n\n## Settings\n\n| Setting| Required | Default | Description |\n|:-------|:--------:|:-------:|:------------|\n| token | True | None | |\n| include_business_streams | False | False | Whether to include streams available only to ReadTheDocs for Business accounts |\n\nA full list of supported settings and capabilities is available by running: `tap-readthedocs --about`\n\n## Installation\n\n```bash\npipx install tap-readthedocs\n```\n\n### Source Authentication and Authorization\n\nGenerate a token: https://readthedocs.org/accounts/tokens/.\n\n## Usage\n\nYou can easily run `tap-readthedocs` by itself or in a pipeline using [Meltano](https://meltano.com/).\n\n### Executing the Tap Directly\n\n```bash\ntap-readthedocs --version\ntap-readthedocs --help\ntap-readthedocs --config CONFIG --discover > ./catalog.json\n```\n\n## Developer Resources\n\n### Initialize your Development Environment\n\n```bash\npipx install hatch\n```\n\n### Create and Run Tests\n\nRun integration tests:\n\n```bash\nhatch run test:integration\n```\n\nYou can also test the `tap-readthedocs` CLI interface directly:\n\n```bash\nhatch run sync:console -- --about --format=json\n```\n\n### Testing with [Meltano](https://www.meltano.com)\n\n_**Note:** This tap will work in any Singer environment and does not require Meltano.\nExamples here are for convenience and to streamline end-to-end orchestration scenarios._\n\nYour 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.\n\n1. Install all plugins\n\n ```bash\n meltano install\n ```\n\n2. Check that the extractor is working properly\n\n ```bash\n meltano invoke tap-readthedocs --version\n ```\n\n3. Execute an ELT pipeline\n\n ```bash\n meltano run tap-readthedocs target-jsonl\n ```\n\n### SDK Dev Guide\n\nSee the [dev guide](https://sdk.meltano.com/en/latest/dev_guide.html) for more instructions on how to use the SDK to\ndevelop your own taps and targets.\n",
"bugtrack_url": null,
"license": null,
"summary": "Singer tap for ReadTheDocs, built with the Meltano SDK for Singer Taps.",
"version": "0.5.15",
"project_urls": {
"Documentation": "https://github.com/reservoir-data/tap-readthedocs#readme",
"Homepage": "https://github.com/reservoir-data/tap-readthedocs",
"Repository": "https://github.com/reservoir-data/tap-readthedocs"
},
"split_keywords": [
"elt",
" readthedocs",
" singer.io"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "246cec14f82c160c9d197a762643b2a347785d11e35c687621af4e9b7bf7540a",
"md5": "56ac48708bef772d61940b566f3915f3",
"sha256": "ff1f1997195b2ebe301f09dee337a583b4a782d5b1249add9039799a1764aecd"
},
"downloads": -1,
"filename": "tap_readthedocs-0.5.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "56ac48708bef772d61940b566f3915f3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 10939,
"upload_time": "2025-10-22T01:01:44",
"upload_time_iso_8601": "2025-10-22T01:01:44.710803Z",
"url": "https://files.pythonhosted.org/packages/24/6c/ec14f82c160c9d197a762643b2a347785d11e35c687621af4e9b7bf7540a/tap_readthedocs-0.5.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "fd30f61b037136ddb63550c55d53503d7c275360abc7a71fc5f7bc2a2b36b56a",
"md5": "a9836c26f210ec668bbfae228c972ea8",
"sha256": "e65b113a473fe2de0dc5131acb9408e77a3e66f37866b13e28969d3b2c7a2049"
},
"downloads": -1,
"filename": "tap_readthedocs-0.5.15.tar.gz",
"has_sig": false,
"md5_digest": "a9836c26f210ec668bbfae228c972ea8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 75480,
"upload_time": "2025-10-22T01:01:46",
"upload_time_iso_8601": "2025-10-22T01:01:46.282420Z",
"url": "https://files.pythonhosted.org/packages/fd/30/f61b037136ddb63550c55d53503d7c275360abc7a71fc5f7bc2a2b36b56a/tap_readthedocs-0.5.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-22 01:01:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "reservoir-data",
"github_project": "tap-readthedocs#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tap-readthedocs"
}
