tap-github is a Singer tap for GitHub.

Build with the Singer SDK.

pipx install git+https://github.com/MeltanoLabs/tap-github.git

This tap accepts the following configuration options:

• Required: One and only one of the following modes:
  1. repositories: an array of strings containing the github repos to be included
  2. organizations: an array of strings containing the github organizations to be included
  3. 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)
  4. user_usernames: a list of github usernames
  5. user_ids: a list of github user ids [int]
• Highly recommended:
  • auth_token -
• Optional:
  • user_agent
  • start_date
  • metrics_log_level
  • stream_maps
  • stream_maps_config

Note that 1-3 are repository modes and 4-5 are user modes and will not run the same set of streams.

A full list of supported settings and capabilities for this tap is available by running:

tap-github --about

A small number of records may be pulled without an auth token. However, a Github auth token should generally be considered "required" since it gives more realistic rate limits. (See GitHub API docs for more info.)

You can easily run tap-github by itself or in a pipeline using Meltano.

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

pipx install poetry
poetry install

Create tests within the tap_github/tests subfolder and then run:

poetry run pytest

You can also test the tap-github CLI interface directly using poetry run:

poetry run tap-github --help

Note: This tap will work in any Singer environment and does not require Meltano. Examples here are for convenience and to streamline end-to-end orchestration scenarios.

Your project comes with a custom meltano.yml project file already created. Open the meltano.yml and follow any "TODO" items listed in the file.

Next, install Meltano (if you haven't already) and any needed plugins:

# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-github
meltano install

Now you can test and orchestrate using Meltano:

# Test invocation:
meltano invoke tap-github --version
# OR run a test `elt` pipeline:
meltano elt tap-github target-jsonl

One-liner to recreate output directory, run elt, and write out state file:

# Update this when you want a fresh state file:
TESTJOB=testjob1

# Run everything in one line
mkdir -p .output && meltano elt tap-github target-jsonl --job_id $TESTJOB && meltano elt tap-github target-jsonl --job_id $TESTJOB --dump=state > .output/state.json

See the dev guide for more instructions on how to use the Singer SDK to develop your own taps and targets.