jiraone

jiraone

A REST API Implementation to Jira Cloud APIs for creating reports and for performing other Jira queries.

Configurations

Install using pip. You have to be on Python >= 3.6.x to utilize this script. From version 0.8.6 will require Python 3.9.x and above.

• Download Python and install it on your device by visiting python.org
• Run the below command either using a virtual environment or from your Python alias

pip install jiraone

OR

python3 -m pip install jiraone

Classes, functions and methods

jiraone comes with various classes, functions and methods. Aliases as well, are used to represent links to classes and functions. The major ones to take note of are the ones shown on the directory link below.

If you would like more information on how to use the classes, methods or functions. Open the jiraone package and read the docstring on the aforementioned methods or functions to get further information.

If you're connecting to a Jira server or data centre, you must change the API endpoint to point to server instances. To do that, change the attribute LOGIN.api = False this helps to use the endpoint /rest/api/latest which is compatible with Jira server or datacenter.

from jiraone import LOGIN

data = "username", "password", "https://server.jiraserver.com"
LOGIN.api = False
LOGIN(*data)

The above login method applies only when you need to access a Jira server or datacenter type instances. The above has little or no effect on cloud instances and will work normally.

Directory

• Using the API
  • endpoint
  • LOGIN
  • echo
  • add_log
  • file_writer
  • file_reader
  • path_builder
  • For
  • replacement_placeholder
  • field
  • comment
  • manage
  • Other Variables
• Basic report usage
  • USER API
  • PROJECT API
  • Module API
  • Support