/sg-jira-bridge

Shotgun / Jira Synchronization

Primary LanguagePythonMIT LicenseMIT

Code style: black Linting Python 2.7 3.7

ShotGrid Jira Bridge

ShotGrid Jira Bridge is a simple synchronization setup between ShotGrid and Jira. It's designed to get you up and running quickly with basic sync functionality for Tasks, Issues, and Notes.

By extending the base syncer and sync handlers you can quickly build custom workflows to connect your ShotGrid and Jira sites. Details like entity types, hierarchy, issue types, fields, statuses, and logic can all be custom defined to match your studio's workflow.

alt text

Components

  • triggers/sg_jira_event_trigger.py: A ShotGrid event trigger which can be used with the ShotGrid Event Daemon
  • webapp.py: A simple web app used as a frontend for the synchronization.
  • service.py: A script to run the web app as a service on Linux and MacOS platforms.
  • win_service.py: (TODO) A script to run the web app as a service on Windows.
  • sg_jira: Python package for handling the synchronization between ShotGrid and Jira.

Documentation

Full documentation is available at https://developer.shotgridsoftware.com/sg-jira-bridge

Requirements

Building the Docs

The documentation is built with Sphinx and is located in the docs/ folder. To build the html output for the docs:

$ pip install -U sphinx sphinx-rtd-theme
$ cd docs
$ make html

Contributing

This project welcomes contributions. Please see our contribution guide at CONTRIBUTING.md