akoebbe / tap-jira

tap-jira

tap-jira

tap-jira is a Singer tap for tap-jira.

Built with the Meltano Tap SDK for Singer Taps.

Capabilities

• catalog
• state
• discover
• about
• stream-maps
• schema-flattening

Configuration

Accepted Config Options

Setting	Required	Default	Description
start_date	False	None	Earliest record date to sync
end_date	False	None	Latest record date to sync
auth	True	None	Auth type for Jira API requires either access_token or username/password
domain	True	None	Site URL
stream_maps	False	None	Config object for stream maps capability. For more information check out Stream Maps.

| | stream_map_config | False | None | User-defined config values to be used within map expressions. | | flattening_enabled | False | None | 'True' to enable schema flattening and automatically expand nested properties. | | flattening_max_depth| False | None | The max depth to flatten schemas. |

The auth setting works either with access token or username/password, set by the following configs:

Auth with access token:

TAP_JIRA_AUTH_FLOW = 'oauth'
TAP_JIRA_AUTH_TOKEN = ''

Auth with username/password:

TAP_JIRA_AUTH_FLOW = 'password'
TAP_JIRA_AUTH_USERNAME = ''
TAP_JIRA_AUTH_PASSWORD = ''

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

tap-jira --about

Elastic License 2.0

The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software.

Installation

pipx install git+https://github.com/ryan-miranda-partners/tap-jira.git

Configure using environment variables

This Singer tap will automatically import any environment variables within the working directory's .env if the --config=ENV is provided, such that config values will be considered if a matching environment variable is set either in the terminal context or in the .env file.

Source Authentication and Authorization

A Jira username and password are required to make API requests. (See Jira API docs for more info)

Usage

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

Stream Inheritance

This project uses parent-child streams. Learn more about them here.

Executing the Tap Directly

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

Developer Resources

Follow these instructions to contribute to this project.

Initialize your Development Environment

pipx install poetry
poetry install

Create and Run Tests

Create tests within the tests subfolder and then run:

poetry run pytest

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

poetry run tap-jira --help

Testing with Meltano

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-jira
meltano install

Now you can test and orchestrate using Meltano:

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

SDK Dev Guide

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