https://github.com/rheinwerk-verlag/planning-poker-jira

Import stories and their description form your Jira sprint board and export the results of your planning poker session back to it.
https://github.com/rheinwerk-verlag/planning-poker-jira

agile django estimation jira planning-poker python scrum story-points

Last synced: about 1 month ago
JSON representation

Import stories and their description form your Jira sprint board and export the results of your planning poker session back to it.

• Host: GitHub
• URL: https://github.com/rheinwerk-verlag/planning-poker-jira
• Owner: rheinwerk-verlag
• License: bsd-3-clause
• Created: 2021-07-19T13:42:03.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-15T13:49:55.000Z (10 months ago)
• Last Synced: 2024-03-26T01:16:47.213Z (9 months ago)
• Topics: agile, django, estimation, jira, planning-poker, python, scrum, story-points
• Language: Python
• Homepage:
• Size: 583 KB
• Stars: 2
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Authors: AUTHORS.rst

Awesome Lists containing this project

README

        
Planning Poker: Jira Extension

==============================

.. image:: https://codecov.io/gh/rheinwerk-verlag/planning-poker-jira/branch/main/graph/badge.svg

   :target: https://codecov.io/gh/rheinwerk-verlag/planning-poker-jira

   :alt: Code Coverage

.. image:: https://readthedocs.org/projects/planning-poker-jira/badge/?version=stable

   :target: https://planning-poker-jira.readthedocs.io/en/stable/?badge=stable

   :alt: 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.

#. Install the Planning Poker Jira app. ::

    $ pip install planning-poker-jira

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

   .. code-block:: python

        INSTALLED_APPS = [

            ...

            'planning_poker',

            'encrypted_fields',

            'planning_poker_jira'

        ]

#. 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.

   .. code-block:: python

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

   See `configuration `_ for more

   ways to customize the application to fit your needs.

#. Run the migrations. ::

    $ python manage.py migrate

#. You can now start your server. ::

    $ python manage.py runserver 0.0.0.0:8000