Git Product home page Git Product logo

django-atlassian's Introduction

Welcome to Django-Atlassian

Django-atlassian allows you to build a Atlassian Connect apps using Django, it includes:
  • JWT support
  • Jira's django db backend
  • Confluence's django db backend

Installation

Download and install using pip install django-atlassina

$ pip install django-atlassian

Example Configuration

Backend mode

DATABASES = {
    'jira': {
        'ENGINE': 'django_atlassian.backends.jira',
        'NAME': 'https://your-site.atlassian.net',
        'USER': '', # Your user
        'PASSWORD': '', # Your password
        'SECURITY': '',
    },

DATABASE_ROUTERS = ['django_atlassian.router.Router']

Application mode

In this mode, you setup a database configuration to connect to a specific Jira/Confluence cloud instance. All custom fields will be automatically introspected.

Setup the router to make the connected host model be accessed through their own database:

DATABASE_ROUTERS = ['django_atlassian.router.Router']

ALLOWED_HOSTS = ['<ID>.ngrok.io']

Create a basic atlassian-connect.json template file:

{
    "name": "<Your app name>",
    "description": "<Your app description>",
    "key": "<Your app private key>",
    "baseUrl": "<Your host set on ALLOWED_HOSTS>",
    "vendor": {
        "name": "<Your company>",
        "url": "<Your website>",
    },
    "authentication": {
        "type": "jwt"
    },
    "lifecycle": {
        "installed": "{% url 'django-atlassian-installed' %}"
    },
    "scopes": [
        "read", "write"
    ],
    "apiVersion": 1,
    "modules": {
    }
}

Contributing

If you'd like to contribute, the best approach is to send a well-formed pull request, complete with tests and documentation. Pull requests should be focused: trying to do more than one thing in a single request will make it more difficult to process.

References

Database implementation:

Dynamic model field injection:

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.