GitHub
Table of Contents
The tap-github
Meltano extractor
pulls data from
GitHub
that can then be sent to a destination using a
loader.
- Repository: https://github.com/singer-io/tap-github
- Maintainer: Stitch
- Last update at: 21 Feb 2022
- Open issues and PRs : 37
- Stars: 66
-
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
Using the Command Line Interface
-
Add the
tap-github
extractor to your project usingmeltano add
:meltano add extractor tap-github
-
Configure the settings below using
meltano config
.
Using Meltano UI
-
Start Meltano UI using
meltano ui
:meltano ui
- Open the Extractors interface at http://localhost:5000/extractors.
- Click the “Add to project” button for “GitHub”.
- Configure the settings below in the “Configuration” interface that opens automatically.
Next steps
Follow the remaining steps of the Getting Started guide:
- Select entities and attributes to extract
- Add a loader to send data to a destination
- Run a data integration (EL) pipeline
If you run into any issues, learn how to get help.
Settings
tap-github
requires the
configuration
of the following settings:
These and other supported settings are documented below. To quickly find the setting you're looking for, use the Table of Contents at the top of the page.
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.
How to use
Manage this setting using Meltano UI,
meltano config
, or an
environment variable:
meltano config tap-github set access_token <access_token>
export TAP_GITHUB_ACCESS_TOKEN=<access_token>
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"
How to use
Manage this setting using Meltano UI,
meltano config
, or an
environment variable:
meltano config tap-github set repository <repository>
export TAP_GITHUB_REPOSITORY=<repository>
Start Date (start_date
)
-
Environment variable:
TAP_GITHUB_START_DATE
Defines how far into the past to pull data for the provided repositories.
How to use
Manage this setting using Meltano UI,
meltano config
, or an
environment variable:
meltano config tap-github set start_date YYYY-MM-DDTHH:MM:SSZ
export TAP_GITHUB_START_DATE=YYYY-MM-DDTHH:MM:SSZ
Looking for help?
If you're having trouble getting the
tap-github
extractor to work, look for an
existing issue in its repository, file a new issue,
or
join the Meltano Slack community
and ask for help in the #plugins-general
channel.
Found an issue on this page?
This page is generated from a YAML file that you can contribute changes to!