README.md

tap-jira

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

This tap:

• Pulls raw data from the JIRA Cloud REST API
• Extracts the following resources:
  • projects
  • versions
  • project_types
  • project_categories
  • resolutions
  • roles
  • users
  • issues
  • issue_comments
  • issue_transitions
  • worklogs
• Outputs the schema for each resource
• Incrementally pulls data based on the input state

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",
        "user_agent": "<user-agent>",
        "request_timeout": 300,
        "groups": "jira-administrators, site-admins, jira-software-users"
    }

   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>",
     "request_timeout": 300,
     "groups": "jira-administrators, site-admins, jira-software-users"
   }

   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.

   The groups specifies groups for users stream. It is an optional parameter. Default value is ["jira-administrators", "jira-software-users", "jira-core-users", "jira-users", "users"].

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