 | GitHub
Code hosting platform |
The tap-github Meltano extractor pulls data from GitHub that can then be sent to a destination using a loader.
Other Available Variants
- meltanolabs
- singer-io (default)
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-github extractor to your project
using
:meltano add -
Configure the tap-github settings using
:meltano config -
Test that extractor settings are valid using
:meltano test
meltano add extractor tap-github --variant meltanolabsmeltano config tap-github set --interactivemeltano test tap-githubNext steps
Follow the remaining steps of the Getting Started guide:
If you run into any issues, learn how to get help.
Capabilities
The current capabilities fortap-githubThis plugin has the following capabilities:
- catalog
- state
- discover
- about
- stream-maps
- schema-flattening
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
tap-github settings that are known to Meltano are documented below. To quickly
find the setting you're looking for, click on any setting name from the list:
user_agentmetrics_log_levelauth_tokenadditional_auth_tokensrate_limit_buffersearchesorganizationsrepositoriesuser_usernamesuser_idsstart_datestream_mapsstream_map_configskip_parent_streams
You can
override these settings or specify additional ones
in your meltano.yml by adding the settings key.
Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.
User Agent (user_agent)
-
Environment variable:
TAP_GITHUB_USER_AGENT
Metrics Log Level (metrics_log_level)
-
Environment variable:
TAP_GITHUB_METRICS_LOG_LEVEL
The log level of the API response metrics.
Auth Token (auth_token)
-
Environment variable:
TAP_GITHUB_AUTH_TOKEN
GitHub token to authenticate with.
Additional Auth Tokens (additional_auth_tokens)
-
Environment variable:
TAP_GITHUB_ADDITIONAL_AUTH_TOKENS
List of GitHub tokens to authenticate with. Streams will loop through them when hitting rate limits.
Rate Limit Buffer (rate_limit_buffer)
-
Environment variable:
TAP_GITHUB_RATE_LIMIT_BUFFER
Add a buffer to avoid consuming all query points for the token at hand. Defaults to 1000.
Searches (searches)
-
Environment variable:
TAP_GITHUB_SEARCHES
An array of search descriptor objects with the following properties. "name" - a human readable name for the search query. "query" - a github search string (generally the same as would come after ?q= in the URL)
Organizations (organizations)
-
Environment variable:
TAP_GITHUB_ORGANIZATIONS
An array of strings containing the github organizations to be included
Repositories (repositories)
-
Environment variable:
TAP_GITHUB_REPOSITORIES
An array of strings containing the github repos to be included
User Usernames (user_usernames)
-
Environment variable:
TAP_GITHUB_USER_USERNAMES
A list of GithHub usernames.
User IDs (user_ids)
-
Environment variable:
TAP_GITHUB_USER_IDS
A list of GitHub user ids.
Start Date (start_date)
-
Environment variable:
TAP_GITHUB_START_DATE
Stream Maps (stream_maps)
-
Environment variable:
TAP_GITHUB_STREAM_MAPS
Stream Map Config (stream_map_config)
-
Environment variable:
TAP_GITHUB_STREAM_MAP_CONFIG
Skip Parent Streams (skip_parent_streams)
-
Environment variable:
TAP_GITHUB_SKIP_PARENT_STREAMS
Set to true to skip API calls for the parent streams (such as repositories) if it is not selected but children are.
Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-generalInstall
meltano add extractor tap-github --variant meltanolabsHomepage
Maintenance Status
-brightgreen){kind=icon}
Maintainer
Meltano Stats
-81-c0c0c4){kind=icon}
-8-c0c0c4){kind=icon}
Keywords
