Skip to main content

JIRA support for Flask without breaking PyCharm inspections.

Project description

A simple JIRA extension for Flask. Supports basic authentication and OAuth.

OAuth is currently untested.

Supported Platforms

  • OSX and Linux.

  • Python 2.7

  • Flask 0.10.1

  • JIRA 0.21

Probably works on other versions too.

Quickstart

Install:

pip install Flask-JIRA-Helper

Example:

# example.py
from flask import Flask
from flask.ext.jira import JIRA

app = Flask(__name__)
app.config['JIRA_SERVER'] = 'https://jira.mycompany.com'
app.config['JIRA_USER'] = 'jdoe'
app.config['JIRA_PASSWORD'] = 'SuperSecretP@ssw0rd'
jira = JIRA(app)

print jira.projects()

Factory Example

# extensions.py
from flask.ext.jira import JIRA

jira = JIRA()
# application.py
from flask import Flask
from extensions import jira

def create_app():
    app = Flask(__name__)
    app.config['JIRA_SERVER'] = 'https://jira.mycompany.com'
    app.config['JIRA_USER'] = 'service'
    app.config['JIRA_PASSWORD'] = 'SuperSecretP@ssw0rd'
    jira.init_app(app)
    return app
# manage.py
from application import create_app

app = create_app()
app.run()

Configuration

Flask-JIRA-Helper subclasses jira.client.JIRA and adds the init_app() method for delayed initialization (for applications that instantiate extensions in a separate file, but run init_app() in the same file Flask() was instantiated).

The following config settings are searched for in the Flask application’s configuration dictionary:

  • JIRA_SERVER – URL to JIRA server.

  • JIRA_USER – HTTP Basic authentication user name.

  • JIRA_PASSWORD – HTTP Basic authentication password.

  • JIRA_TOKEN – OAuth authentication access token.

  • JIRA_SECRET – OAuth authentication access token secret.

  • JIRA_CONSUMER – OAuth authentication consumer key.

  • JIRA_CERT – OAuth authentication key certificate data.

Changelog

0.1.2

  • Fixed AttributeError when JIRA is instantiated but init_app() isn’t called.

0.1.1

  • Clearer error message when no credentials are specified.

0.1.0

  • Initial release.

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

Flask-JIRA-Helper-0.1.2.tar.gz (4.6 kB view details)

Uploaded Source

File details

Details for the file Flask-JIRA-Helper-0.1.2.tar.gz.

File metadata

File hashes

Hashes for Flask-JIRA-Helper-0.1.2.tar.gz
Algorithm Hash digest
SHA256 02f886005048cd3181a51dc7bb097177653e13003beb08a42bdff5e1a449dd87
MD5 1e889e13ba1051f9ca7b3c5f39bc29a4
BLAKE2b-256 5a6d82121de7ecdbd5d5ff0af4075477777f0655a4a220e2cf42dd4528a8b870

See more details on using hashes here.

Supported by

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