Skip to main content

Easily run complex SQL-like queries far beyond what Jira's standard JQL query language can provide.

Project description

Join the chat at https://gitter.im/coddingtonbear/jira-select

Jira-Select: Get the data you want to see out of Jira

Jira-select is a command-line tool and library that lets you run SQL-like queries against your Jira instance that are far beyond what Jira's built-in query language can provide.

Jira has its own query language but there are many limitations around what JQL is capable of. Some data is returned in arcane formats (e.g. sprint names are returned as a string looking something like com.atlassian.greenhopper.service.sprint.Sprint@14b1c359[id=436...), data cannot be grouped (there's nothing like SQL's GROUP BY statement), and because of that lack of grouping, there are no aggregation functions -- no SUM-ing story points or estimates per-assignee for you. And if you want to write a custom function for processing a field, well, I'm not even sure where you'd begin. Jira-select makes those things easy.

If you've ever found yourself held back by the limitations of Jira's built-in query language, this tool may make your life easier. Using Jira-select you can perform a wide variety of SQL-like query operations including grouping, aggregation, custom functions, and more.

Supported Platforms

  • Linux
  • Windows
  • OSX

Installation

You can either install from pip:

pip install jira-select

or you can download the latest packaged release here:

https://github.com/coddingtonbear/jira-select/releases

or you can build from source:

git clone https://github.com/coddingtonbear/jira-select.git
cd jira-select
pip install -e .

Quickstart

First, you need to configure jira-select to connect to your jira instance:

jira-select configure

Then, you can open up your shell:

jira-select shell

Now, you can type out your query -- the below will find issues assigned to you:

select:
 Issue Key: key
 Issue Summary: summary
from: issues
where:
  - assignee = "your-email@somecompany.com"
  - resolution is null

The editor uses vi bindings by default; so once you're ready to submit your query, press Esc followed by Enter and after a short wait (watch the progressbars), you'll be shown your results. Press q to exit your results.


  • Documentation for Jira-select is available on ReadTheDocs.
  • Please post issues on Github.
  • Questions? Ask them on Gitter.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jira-select-3.0.0a1.tar.gz (42.3 kB view details)

Uploaded Source

File details

Details for the file jira-select-3.0.0a1.tar.gz.

File metadata

  • Download URL: jira-select-3.0.0a1.tar.gz
  • Upload date:
  • Size: 42.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for jira-select-3.0.0a1.tar.gz
Algorithm Hash digest
SHA256 e9351508824cb9f6294ffe8a98a5cb4842a4f7b1efd2434811cab23e465b793f
MD5 c8661b93dcdd59cfeeb1fc54e591f344
BLAKE2b-256 6406258ac5a5fc2cf6b571b0638163cc4e68fbf696e2998ada0693475a7827a1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page