A Singer tap for extracting data from the GitHub API
Python
Clone or download
Latest commit fae2f86 May 21, 2018
Permalink
Failed to load latest commit information.
tap_github adding the rest of the fields for reviews Apr 10, 2018
.gitignore init Mar 1, 2017
CHANGELOG.md bump to 1.0.0 May 21, 2018
LICENSE init Mar 1, 2017
MANIFEST.in add newline Apr 4, 2018
README.md Update README.md Apr 10, 2018
config.sample.json init Mar 1, 2017
setup.py bump to 1.0.0 May 21, 2018
tap_github.py write metadata and allow full property selection May 21, 2018

README.md

tap-github

This is a Singer tap that produces JSON-formatted data from the GitHub API following the Singer spec.

This tap:

Quick start

  1. Install

    We recommend using a virtualenv:

    > virtualenv -p python3 venv
    > source venv/bin/activate
    > pip install tap-github
  2. Create a GitHub access token

    Login to your GitHub account, go to the Personal Access Tokens settings page, and generate a new token with at least the repo scope. Save this access token, you'll need it for the next step.

  3. Create the config file

    Create a JSON file containing the access token you just created and the path to the repository. The repo path is relative to https://github.com/. For example the path for this repository is singer-io/tap-github.

    {"access_token": "your-access-token",
     "repository": "singer-io/tap-github"}
  4. Run the tap in discovery mode to get properties.json file

    tap-github --config config.json --discover > properties.json
  5. In the properties.json file, select the streams to sync

    Each stream in the properties.json file has a "schema" entry. To select a stream to sync, add "selected": true to that stream's "schema" entry. For example, to sync the pull_requests stream:

    ...
    "tap_stream_id": "pull_requests",
    "schema": {
      "selected": true,
      "properties": {
        "updated_at": {
          "format": "date-time",
          "type": [
            "null",
            "string"
          ]
        }
    ...
    
  6. Run the application

    tap-github can be run with:

    tap-github --config config.json --properties properties.json

Copyright © 2018 Stitch