Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gearplug/jira-python
Jira Software wrapper written in python
https://github.com/gearplug/jira-python
api authentication basic jira library notifications python software subscription webhook wrapper
Last synced: 3 days ago
JSON representation
Jira Software wrapper written in python
- Host: GitHub
- URL: https://github.com/gearplug/jira-python
- Owner: GearPlug
- License: mit
- Created: 2017-12-01T16:17:24.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-28T13:49:53.000Z (over 1 year ago)
- Last Synced: 2024-11-02T02:06:10.333Z (12 days ago)
- Topics: api, authentication, basic, jira, library, notifications, python, software, subscription, webhook, wrapper
- Language: Python
- Homepage:
- Size: 27.3 KB
- Stars: 5
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://github.com/GearPlug/jira-python/issues).
#### 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