跳转到主要内容

Singer tap for ReadTheDocs,使用Meltano SDK for Singer Taps构建。

项目描述

tap-readthedocs

Singer Tap for Read the Docs. Built with the Meltano Singer SDK.

功能

  • catalog
  • state
  • discover
  • about
  • stream-maps

设置

设置 必需 默认 描述
token True None
include_business_streams False False 是否包括仅限于ReadTheDocs商业账户的流

通过运行: tap-readthedocs --about 可以获得支持的所有设置和功能列表。

安装

pipx install tap-readthedocs

源认证和授权

生成令牌:[生成令牌](https://readthedocs.org/accounts/tokens/).

用法

您可以直接运行 tap-readthedocs 或在使用 Meltano 的管道中运行。

直接执行 Tap

tap-readthedocs --version
tap-readthedocs --help
tap-readthedocs --config CONFIG --discover > ./catalog.json

开发者资源

初始化您的开发环境

pipx install hatch

创建和运行测试

运行集成测试

hatch run test:integration

您还可以直接测试 tap-readthedocs CLI 接口

hatch run sync:console -- --about --format=json

使用 Meltano 进行测试

注意:此 tap 可在任何 Singer 环境中工作,且不需要 Meltano。此处提供的示例仅为了方便,并简化端到端编排场景。

您的项目已经包含一个自定义的 meltano.yml 项目文件。如果您尚未安装,请先安装 Meltano

  1. 安装所有插件

    meltano install
    
  2. 检查提取器是否正常工作

    meltano invoke tap-readthedocs --version
    
  3. 执行 ELT 管道

    meltano run tap-readthedocs target-jsonl
    

SDK 开发指南

请参阅开发指南,了解如何使用 SDK 开发自己的 taps 和 targets。

项目详情


下载文件

下载您平台上的文件。如果您不确定选择哪个,请了解更多关于 安装软件包 的信息。

源分布

tap_readthedocs-0.5.1.tar.gz (14.5 kB 查看哈希)

上传时间:

构建分布

tap_readthedocs-0.5.1-py3-none-any.whl (15.2 kB 查看哈希)

上传时间: Python 3

由以下组织支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面