Detect and render the streams list for taps when discoverable

[aaronsteers]

Detect and render the streams list for taps when discoverable

[aaronsteers]

/test-plugin name=tap-github pip-url=git+https://github.com/MeltanoLabs/tap-github.git

Starting test job...
...
Job completed.

Auto-generated README.md

tap-github

GitHub tap class.

Built with the Meltano Singer SDK.

Capabilities

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

Settings

Setting	Required	Default	Description
user_agent	False	None
metrics_log_level	False	None
auth_token	False	None	GitHub token to authenticate with.
additional_auth_tokens	False	None	List of GitHub tokens to authenticate with. Streams will loop through them when hitting rate limits.
rate_limit_buffer	False	None	Add a buffer to avoid consuming all query points for the token at hand. Defaults to 1000.
searches	False	None
organizations	False	None
repositories	False	None
user_usernames	False	None
user_ids	False	None
start_date	False	None
stream_maps	False	None
stream_map_config	False	None
skip_parent_streams	False	None	Set to true to skip API calls for the parent streams (such as repositories) if it is not selected but children are
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.

A full list of supported settings and capabilities is available by running: tap-github --about

Version info

tap-github v1.1.1, Meltano SDK v0.14.0

Usage info

melty-bot % tap-github --help
Usage: tap-github [OPTIONS]

  Execute the Singer tap.

Options:
  --state PATH              Use a bookmarks file for incremental replication.
  --catalog PATH            Use a Singer catalog file with the tap.
  --test TEXT               Use --test to sync a single record for each
                            stream. Use --test=schema to test schema output
                            without syncing records.
  --discover                Run the tap in discovery mode.
  --config TEXT             Configuration file location or 'ENV' to use
                            environment variables.
  --format [json|markdown]  Specify output style for --about
  --about                   Display package metadata and settings.
  --version                 Display the package version.
  --help                    Show this message and exit.

Detected capabilities

• ✅ 'discover'
• ✅ 'catalog'
• ✅ 'state'
• ✅ 'about'

JSON Metadata

{
  "name": "tap-github",
  "description": "GitHub tap class.",
  "version": "1.1.1",
  "sdk_version": "0.14.0",
  "capabilities": [
    "catalog",
    "state",
    "discover",
    "about",
    "stream-maps",
    "schema-flattening"
  ],
  "settings": {
    "type": "object",
    "properties": {
      "user_agent": {
        "type": [
          "string",
          "null"
        ]
      },
      "metrics_log_level": {
        "type": [
          "string",
          "null"
        ]
      },
      "auth_token": {
        "type": [
          "string",
          "null"
        ],
        "description": "GitHub token to authenticate with."
      },
      "additional_auth_tokens": {
        "type": [
          "array",
          "null"
        ],
        "items": {
          "type": [
            "string"
          ]
        },
        "description": "List of GitHub tokens to authenticate with. Streams will loop through them when hitting rate limits."
      },
      "rate_limit_buffer": {
        "type": [
          "integer",
          "null"
        ],
        "description": "Add a buffer to avoid consuming all query points for the token at hand. Defaults to 1000."
      },
      "searches": {
        "type": [
          "array",
          "null"
        ],
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": [
                "string"
              ]
            },
            "query": {
              "type": [
                "string"
              ]
            }
          },
          "required": [
            "name",
            "query"
          ]
        }
      },
      "organizations": {
        "type": [
          "array",
          "null"
        ],
        "items": {
          "type": [
            "string"
          ]
        }
      },
      "repositories": {
        "type": [
          "array",
          "null"
        ],
        "items": {
          "type": [
            "string"
          ]
        }
      },
      "user_usernames": {
        "type": [
          "array",
          "null"
        ],
        "items": {
          "type": [
            "string"
          ]
        }
      },
      "user_ids": {
        "type": [
          "array",
          "null"
        ],
        "items": {
          "type": [
            "string"
          ]
        }
      },
      "start_date": {
        "type": [
          "string",
          "null"
        ],
        "format": "date-time"
      },
      "stream_maps": {
        "type": [
          "object",
          "null"
        ],
        "properties": {}
      },
      "stream_map_config": {
        "type": [
          "object",
          "null"
        ],
        "properties": {}
      },
      "skip_parent_streams": {
        "type": [
          "boolean",
          "null"
        ],
        "description": "Set to true to skip API calls for the parent streams (such as repositories) if it is not selected but children are"
      },
      "flattening_enabled": {
        "type": [
          "boolean",
          "null"
        ],
        "description": "'True' to enable schema flattening and automatically expand nested properties."
      },
      "flattening_max_depth": {
        "type": [
          "integer",
          "null"
        ],
        "description": "The max depth to flatten schemas."
      }
    }
  }
}

Discovered streams

• anonymous_contributors
• assignees
• collaborators
• commit_comments
• commits
• community_profile
• contributors
• dependencies
• dependents
• events
• extra-metrics
• issue_comments
• issue_events
• issues
• languages
• milestones
• organizations
• project_cards
• project_columns
• projects
• pull_request_commits
• pull_requests
• readme
• readme_html
• releases
• repositories
• review_comments
• reviews
• stargazers
• stargazers_rest
• starred
• stats_contributors
• team_members
• team_roles
• teams
• user_contributed_to
• users
• workflow_run_jobs
• workflow_runs
• workflows

[aaronsteers]

/test-plugin name=tap-messagebird pip-url=git+https://github.com/MeltanoLabs/tap-messagebird.git

Starting test job...
...
Job completed.

Auto-generated README.md

tap-messagebird

Messagebird tap class.

Built with the Meltano Singer SDK.

Capabilities

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

Settings

Setting	Required	Default	Description
api_key	True	None	The token to authenticate against the API service. Test keys are not supported for Conversations see https://support.messagebird.com/hc/en-us/articles/360000670709-What-is-the-difference-between-a-live-key-and-a-test-key-
start_date	False	2020-01-20T22:31:10.904432Z	When to pull records starting at what date. ISO8601 format of date, defaults to 3 years ago.
stream_maps	False	None	Config object for stream maps capability. For more information check out Stream Maps.
stream_map_config	False	None	User-defined config values to be used within map expressions.
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.

A full list of supported settings and capabilities is available by running: tap-messagebird --about

Version info

tap-messagebird v0.0.1.post5+551f872, Meltano SDK v0.14.0

Usage info

melty-bot % tap-messagebird --help
Usage: tap-messagebird [OPTIONS]

  Execute the Singer tap.

Options:
  --state PATH              Use a bookmarks file for incremental replication.
  --catalog PATH            Use a Singer catalog file with the tap.
  --test TEXT               Use --test to sync a single record for each
                            stream. Use --test=schema to test schema output
                            without syncing records.
  --discover                Run the tap in discovery mode.
  --config TEXT             Configuration file location or 'ENV' to use
                            environment variables.
  --format [json|markdown]  Specify output style for --about
  --about                   Display package metadata and settings.
  --version                 Display the package version.
  --help                    Show this message and exit.

Detected capabilities

• ✅ 'discover'
• ✅ 'catalog'
• ✅ 'state'
• ✅ 'about'

JSON Metadata

{
  "name": "tap-messagebird",
  "description": "Messagebird tap class.",
  "version": "0.0.1.post5+551f872",
  "sdk_version": "0.14.0",
  "capabilities": [
    "catalog",
    "state",
    "discover",
    "about",
    "stream-maps",
    "schema-flattening"
  ],
  "settings": {
    "type": "object",
    "properties": {
      "api_key": {
        "type": [
          "string"
        ],
        "description": "The token to authenticate against the API service. Test keys are not supported for Conversations see https://support.messagebird.com/hc/en-us/articles/360000670709-What-is-the-difference-between-a-live-key-and-a-test-key-",
        "secret": true,
        "writeOnly": true
      },
      "start_date": {
        "type": [
          "string",
          "null"
        ],
        "format": "date-time",
        "default": "2020-01-20T22:31:10.432638Z",
        "description": "When to pull records starting at what date. ISO8601 format of date, defaults to 3 years ago."
      },
      "stream_maps": {
        "type": [
          "object",
          "null"
        ],
        "properties": {},
        "description": "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": {
        "type": [
          "object",
          "null"
        ],
        "properties": {},
        "description": "User-defined config values to be used within map expressions."
      },
      "flattening_enabled": {
        "type": [
          "boolean",
          "null"
        ],
        "description": "'True' to enable schema flattening and automatically expand nested properties."
      },
      "flattening_max_depth": {
        "type": [
          "integer",
          "null"
        ],
        "description": "The max depth to flatten schemas."
      }
    },
    "required": [
      "api_key"
    ]
  }
}

Discovered streams

• conversation
• message