to install all packages: pip3 install -r requirements.txt
install PyJama: https://github.com/jamasoftware-ps/py-jama-rest-client
install Atlassian python client: pip3 install atlassian-python-api
Authentication documentation with atlassian python api: https://atlassian-python-api.readthedocs.io/
jira module documentation: https://atlassian-python-api.readthedocs.io/jira.html
install flask:pip3 install flask
install the java web token library pip3 install flask-jwt-extended
install Flask-CORS pip3 install flask-cors
install python-json-logger pip3 install python-json-logger
navigate into the server folder then run python routes.py
this will start the server on HTTP://0.0.0.0:50000 and you wont get any of the nice VS code debugging tools. In addition you will need to set several environment variables
JIRA_SYNC_ORG
JIRA_SYNC_USERNAME
JIRA_SYNC_PASSWORD
JAMA_SYNC_ORG
JAMA_SYNC_USERNAME
JAMA_SYNC_PASSWORD
SYNC_INTERVAL
(in seconds)
to run through VS Code shft+cmd+D
will take you to the debug console. from there you will be given the option of running the code. select python: flask app
from the list of options and set the path to server.py
see link for more information about running flask in VS Code
https://code.visualstudio.com/docs/python/tutorial-flask
make sure that you're using the correct python environment otherwise pyjama and flask wont work
contact Spencer if you are having any issues getting it running.
the database can be directly viewed and edditied using DataGrip, just point it to the .db file.