Code Monkey home page Code Monkey logo

tap-jira's Introduction

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",
         "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"
    }

or (for Personal Access Token):

{
    "start_date": "2010-01-01",
    "access_token": "<personal-access-token>",
    "base_url": "https://your-jira-domain",
    "user_agent": "<user-agent>",
    "request_timeout": 300
}

 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"]`.

4. Run the Tap in Discovery Mode

tap-jira -c config.json -d


See the Singer docs on discovery mode
[here](https://github.com/singer-io/getting-started/blob/master/docs/DISCOVERY_MODE.md#discovery-mode).

5. Run the Tap in Sync Mode

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


---

Copyright &copy; 2017 Stitch

tap-jira's People

Contributors

luandy64 avatar b-ryan avatar dmosorast avatar poeticmichael avatar indigojump avatar kspeer825 avatar krispersonal avatar nick-mccoy avatar kallan357 avatar dbshah1212 avatar asaf-erlich avatar prijendev avatar savan-chovatiya avatar namrata270998 avatar jtilala avatar bhtowles avatar shantanu73 avatar rpaterson avatar mdelaurentis avatar henriallik avatar cosimon avatar ullauri avatar briansloane avatar loeakaodas avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.