The tap-github extractor pulls data from GitHub that can then be sent to a destination using a loader.
Alternate Implementations
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 config
meltano add extractor tap-github --variant singer-io
meltano config tap-github set --interactive
meltano config tap-github test
Next 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 for
tap-github
may have been automatically set when originally added to the Hub. Please review the
capabilities when using this extractor. If you find they are out of date, please
consider updating them by making a pull request to the YAML file that defines the
capabilities for this extractor.
This plugin has the following capabilities:
- discover
- properties
- state
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:
You can also list these settings using
with the meltano config
list
subcommand:
meltano config tap-github list
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.
Personal Access Tokens (access_token)
-
Environment variable:
TAP_GITHUB_ACCESS_TOKEN
Personal access token used to authenticate with GitHub. The token can be generated by going to the Personal Access Token settings page.
Configure this setting directly using the following Meltano command:
meltano config tap-github set access_token [value]
Repositories (repository)
-
Environment variable:
TAP_GITHUB_REPOSITORY
Space-separated list of repositories. Each repository must be prefaced by the user/organization name, e.g. "meltano/meltano meltano/sdk meltano/hub"
Configure this setting directly using the following Meltano command:
meltano config tap-github set repository [value]
Start Date (start_date)
-
Environment variable:
TAP_GITHUB_START_DATE
Defines how far into the past to pull data for the provided repositories.
Configure this setting directly using the following Meltano command:
meltano config tap-github set start_date [value]
Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general
channel.