Configure a generic task server
PyCharm supports integration with many task trackers out of the box. However, if you use a tracker that PyCharm does not support yet, you can still integrate it configuring a so called generic server.
This tutorial describes how to:
Connect to JIRA Cloud as a generic server.
Obtain the list of issues assigned to you.
For each issue, get its ID, title, description, date and time when the issue was created and updated.
Before you start configuring a connection to your tracker, note that PyCharm:
Supports only services with REST API.
Supports either Basic HTTP authentication or sending preliminary requests to the server.
Supports GET and POST requests.
Does not support pagination in server responses.
Specify server URL and credentials
In the Settings/Preferences dialog Ctrl+Alt+S, go to Tools | Tasks | Servers.
Click and select Generic.
On the General tab, specify the URL of your task tracker and connection credentials.
In the Username field, type your email address.
In the Password field, enter your Atlassian API token.
Select the Use HTTP authentication checkbox at the bottom of the dialog.
Configure the server settings
Switch to the Server Configuration tab.
Note that the Login URL field will be disabled, as you are using HTTP authentication.
In the Tasks List URL, enter the URL for obtaining issues from the server. You can use variables or enter the full URL:
{serverUrl}
/rest or https://serverurl.atlassian.net/api /2 /search /rest /api /2 /search The
{serverUrl}
is a variable that stands for the URL you have specified on the General tab.Add the
?jql={JQL_Query}
expression to your task list URL: {serverUrl}/rest ./api /2 /search?jql={JQL_Query} tip
You can use code completion in the Login URL, Tasks List URL and Single Task URL fields.
Click Manage Template Variables at the bottom of the dialog to configure the
JQL_Query
variable.Click and in the new field, specify the variable name
JQL_Query
and add its valueassignee = currentUser() AND resolution = unresolved
.This will let you obtain unresolved issues assigned to you.
Click OK.
note
All variables specified in URL fields, except
{serverUrl}
, are encoded withapplication/x-www-form-urlencoded
by default.
tip
For more information on how to do advanced searches, refer to Advanced searching - fields reference.
Configure response type and specify selectors
In the Server Configuration dialog, select the JSON response type.
Specify selectors in the table to get IDs and titles of issues and their description. You can also obtain the date and time when issues were created and updated:
tasks:
$.issues
id:
key
summary:
fields.summary
description:
fields.description
updated:
fields.updated
created:
fields.created
tip
For JIRA, you can check the server responses in real time. Replace placeholders with actual values in the link and open it in a browser: http://<serverURL>:<port>
/rest /api /2 /search Click Test to make sure all parameters are configured correctly.
Upload issues from the server
Click the tasks combo and select Open Task. PyCharm will load from the server all issues that match your configuration.
Select the necessary issue from the list.
Press Ctrl+Q to open issue description and make sure all required details are obtained.