Skip to content

Latest commit

 

History

History
69 lines (45 loc) · 2.35 KB

README.rst

File metadata and controls

69 lines (45 loc) · 2.35 KB
Raw

Planning Poker: Jira Extension

Code Coverage Documentation Status

This application extends the Planning Poker app with the ability to import stories and their description from Jira and export the estimated amount of story points back to the Jira instance.

This extension also serves as an example on how to add custom behaviour to/extend the functionality of the Planning Poker app.

Features

  • ⬇️ Import stories from your backlog and use them to poker.
  • ⬆️ Export story points back to the Jira backend hassle-free.
  • 📋 Easily manage multiple Jira backends.
  • 🔒 Securely safe your password in an encrypted database field.

Quickstart

You'll need an existing system with the Planning Poker app installed. See its documentation if you haven't already.

  1. Install the Planning Poker Jira app.

    $ pip install planning-poker-jira

  2. Add the app and its dependencies to the list of your installed apps.

    INSTALLED_APPS = [
    ...
    'planning_poker',
    'encrypted_fields',
    'planning_poker_jira'
]

  3. Add encryption keys to your settings. This is used to encrypt your passwords before they are stored in the database. If you don't already have this defined, it's probably easiest to take your SECRET_KEY and convert it to hex since that should be kept secret anyways. See encrypted fields docs for more information on this setting.

    FIELD_ENCRYPTION_KEYS = [SECRET_KEY.encode().hex()[:64]]

    See configuration for more ways to customize the application to fit your needs.

  4. Run the migrations.

    $ python manage.py migrate

  5. You can now start your server.

    $ python manage.py runserver 0.0.0.0:8000