Skip to content
A Singer.io tap for extracting data from the JIRA API
Python Makefile
Branch: master
Clone or download

README.md

tap-jira

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

This tap:

Quick Start

  1. Install

    pip install tap-jira

  2. Create the config file

    Create a JSON file called config.json. Its contents should look like (for Basic Auth):

     {
         "start_date": "2010-01-01",
         "username": "your-jira-username",
         "password": "your-jira-password",
         "base_url": "https://your-jira-domain"
     }

    or (for OAuth):

    {
      "oauth_client_secret": "<oauth-client-secret>",
      "user_agent": "<user-agent>",
      "oauth_client_id": "<oauth-client-id>",
      "access_token": "<access-token>",
      "cloud_id": "<cloud-id>",
      "refresh_token": "<refresh-token>",
      "start_date": "<i.e. 2017-12-04T19:19:32Z>"
    }

    The start_date specifies the date at which the tap will begin pulling data (for those resources that support this).

    For Basic Auth, the base_url is the URL where your Jira installation can be found. For example, it might look like: https://mycompany.atlassian.net.

  3. Run the Tap in Discovery Mode

    tap-jira -c config.json -d
    

    See the Singer docs on discovery mode here.

  4. Run the Tap in Sync Mode

    tap-jira -c config.json -p catalog-file.json
    

Copyright © 2017 Stitch

You can’t perform that action at this time.