Skip to main content

API wrapper for Jira CRM Graph written in Python

Project description

jira-python

jira-python is an API wrapper for Jira Software written in Python.

This library uses API version 2 and Basic Authentication for requests.

If you are looking for Jira Software Cloud using OAuth 2.0 (3LO) and the latest API version: https://github.com/ingmferrer/jira-cloud-python

Installing

pip install jira-python

Usage

from jira.client import Client

client = Client('HOST', 'USER', 'PASSWORD') # Host must have trailing slash

Get user permissions

response = client.get_permissions()

Get all projects

response = client.get_all_projects()

Get an issue

response = client.get_issue('ISSUE_ID)

Create an issue

data = {'fields':
             {'description': 'Issue description',
              'reporter': {'name': 'ingmferrer'},
              'assignee': {'name': 'ingmferrer'},
              'project': {'id': '10400'},
              'issuetype': {'id': '10002'},
              'summary': 'Issue summary'}}

response = client.create_issue(data)

Delete an issue

response = client.delete_issue('ISSUE_ID')

Get metadata for issues

response = client.get_create_issue_meta()

Get metadata for issues

response = client.get_create_issue_meta()

Webhooks

Get a webhook

response = client.get_webhook('WEBHOOK_ID')

Get all webhooks

response = client.get_all_webhooks()

Get all webhooks

data = {
    "name": "Webhook",
    "url": "https://mywebsite.com/notification_url/",
    "events": [
        "jira:issue_created"
    ],
    "jqlFilter": "Project = KEY", #Change KEY to your project key. Project key != project id
    "excludeIssueDetails": False
}
response = client.create_webhook(data)

Delete a webhook

response = client.delete_webhook()

Contributing

We are always grateful for any kind of contribution including but not limited to bug reports, code enhancements, bug fixes, and even functionality suggestions.

You can report any bug you find or suggest new functionality with a new issue.

If you want to add yourself some functionality to the wrapper:

  1. Fork it ( https://github.com/GearPlug/jira-python )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Adds my new feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

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_python-0.2.4.tar.gz (5.3 kB view details)

Uploaded Source

Built Distribution

jira_python-0.2.4-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file jira_python-0.2.4.tar.gz.

File metadata

  • Download URL: jira_python-0.2.4.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.9

File hashes

Hashes for jira_python-0.2.4.tar.gz
Algorithm Hash digest
SHA256 e01a9736a668e59a0410ba75122695419302c83208784de49bf5ae5e69c4697f
MD5 2f1d73f873151449b3542cf160965e48
BLAKE2b-256 e6b64d1671b37ef9745353c7954ce9f3e9caaba0b25a9208eb9b57ab12f173db

See more details on using hashes here.

File details

Details for the file jira_python-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: jira_python-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 6.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.9

File hashes

Hashes for jira_python-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ce77acd7f221a2361a4c991ab983be3f1c365fb127ce5c574c0348a83d0bc233
MD5 631c46e0cd0c2029ae27c9a2284322df
BLAKE2b-256 e6b999d7424c9d465461896683c90439194233207b4da4d7205fb50fd6fffc80

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