Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/z3z1ma/tap-jira
`tap-jira` is a Singer tap for Jira built with the Meltano SDK
https://github.com/z3z1ma/tap-jira
Last synced: about 1 month ago
JSON representation
`tap-jira` is a Singer tap for Jira built with the Meltano SDK
- Host: GitHub
- URL: https://github.com/z3z1ma/tap-jira
- Owner: z3z1ma
- Created: 2022-06-12T07:29:41.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-06-12T07:36:31.000Z (over 2 years ago)
- Last Synced: 2024-10-13T07:28:17.441Z (2 months ago)
- Language: Python
- Size: 34.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# tap-jira
`tap-jira` is a Singer tap for Jira.
Built with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.
## Installation
- [ ] `Developer TODO:` Update the below as needed to correctly describe the install procedure. For instance, if you do not have a PyPi repo, or if you want users to directly install from your git repo, you can modify this step as appropriate.
```bash
pipx install git+https://github.com/z3z1ma/tap-jira
```
## Configuration
### Accepted Config Options
- [ ] `Developer TODO:` Provide a list of config options accepted by the tap.
A full list of supported settings and capabilities for this
tap is available by running:
```bash
tap-jira --about
```
### 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
- [ ] `Developer TODO:` If your tap requires special access on the source system, or any special authentication requirements, provide those here.
## Usage
You can easily run `tap-jira` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Tap Directly
```bash
tap-jira --version
tap-jira --help
tap-jira --config CONFIG --discover > ./catalog.json
```
## Developer Resources
- [ ] `Developer TODO:` As a first step, scan the entire project for the text "`TODO:`" and complete any recommended steps, deleting the "TODO" references once completed.
### Initialize your Development Environment
```bash
pipx install poetry
poetry install
```
### Create and Run Tests
Create tests within the `tap_jira/tests` subfolder and
then run:
```bash
poetry run pytest
```
You can also test the `tap-jira` CLI interface directly using `poetry run`:
```bash
poetry run tap-jira --help
```
### Testing with [Meltano](https://www.meltano.com)
_**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:
```bash
# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-jira
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# 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](https://sdk.meltano.com/en/latest/dev_guide.html) for more instructions on how to use the SDK to
develop your own taps and targets.