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.4.2.tar.gz (90.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jira_select-3.4.2-py3-none-any.whl (65.0 kB view details)

Uploaded Python 3

File details

Details for the file jira_select-3.4.2.tar.gz.

File metadata

  • Download URL: jira_select-3.4.2.tar.gz
  • Upload date:
  • Size: 90.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for jira_select-3.4.2.tar.gz
Algorithm Hash digest
SHA256 72cecbf94df7f0d5453e5836ff36034dede7bd339858cc7fba33e6c6fa76a42f
MD5 97a2fc82369bc4168d7dc2514068f385
BLAKE2b-256 c190a5563a98fae20e54f20557d34f08ebfb8a6e7c8013d952d1103495cf3a98

See more details on using hashes here.

File details

Details for the file jira_select-3.4.2-py3-none-any.whl.

File metadata

  • Download URL: jira_select-3.4.2-py3-none-any.whl
  • Upload date:
  • Size: 65.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for jira_select-3.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1865ae874e618d03efa5f162d503878c69071d410b84a9103908939d09d1bc99
MD5 fa2b075343a67cfd720ef873c5f77f33
BLAKE2b-256 70236acd3ccfebd19184f3cc356f5a36150fe68e0764161181c92cbbe4487673

See more details on using hashes here.

Supported by

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