Python jira 라이브러리를 이용해 JIRA를 관리하는 방법

Python

Author

gabriel yang

Published

October 5, 2024

JIRA는 애자일 개발, 프로젝트 관리, 이슈 추적을 지원하는 도구로, 많은 개발 팀에서 애용하고 있습니다. JIRA API를 직접 사용하여 이슈를 관리할 수도 있지만, Python에서 JIRA의 기능을 더욱 쉽게 사용할 수 있는 jira 라이브러리가 제공됩니다.

1. JIRA 라이브러리 개요

jira 라이브러리는 Atlassian JIRA의 REST API에 접근하여 프로젝트와 이슈 관리 작업을 쉽게 할 수 있도록 도와주는 Python 패키지입니다. 이를 통해 프로젝트, 이슈, 사용자 등을 관리하고, JIRA에서 제공하는 거의 모든 기능을 사용할 수 있습니다.

2. JIRA 라이브러리 설치

Python에서 JIRA 라이브러리를 사용하려면 먼저 설치가 필요합니다. pip 명령어를 사용해 라이브러리를 설치할 수 있습니다.

pip install jira

이 명령을 실행하면 jira 라이브러리가 설치되고, 이후로 JIRA의 API를 간편하게 사용할 수 있습니다.

3. JIRA 서버에 연결

JIRA REST API에 접근하려면 JIRA 인스턴스와 인증 정보가 필요합니다. API 토큰 기반 인증을 사용하며, 이를 위해 이메일과 API 토큰을 생성해야 합니다.

1) API 토큰 생성

JIRA에 로그인한 후 계정 설정 페이지로 이동합니다.
Security 탭에서 API Token을 생성합니다.
생성된 API 토큰을 저장해 두세요. 이는 인증 시에 필요합니다.

2) Python 코드로 JIRA 서버 연결

jira 라이브러리를 사용하여 JIRA 서버에 연결하는 방법은 다음과 같습니다.

from jira import JIRA

# JIRA 서버 URL과 인증 정보
jira_url = 'https://your-domain.atlassian.net'
email = 'your-email@example.com'
api_token = 'your-api-token'

# JIRA 연결 설정
jira = JIRA(server=jira_url, basic_auth=(email, api_token))

# JIRA에 연결 확인
print(f"Successfully connected to JIRA: {jira_url}")

이 코드에서는 JIRA 인스턴스의 URL과 사용자 이메일, API 토큰을 사용해 인증하고, JIRA 인스턴스에 연결합니다.

4. JIRA 이슈 조회 및 생성

JIRA의 주요 기능 중 하나는 이슈 관리입니다. 이슈는 JIRA에서 모든 작업 항목을 의미하며, 다양한 타입으로 나뉩니다. 여기서는 이슈를 조회하고, 새로운 이슈를 생성하는 방법을 설명합니다.

1) 이슈 조회

JIRA에서 이슈를 조회하려면 issue 메서드를 사용하면 됩니다. 다음 코드는 특정 이슈를 조회하는 예입니다.

# 특정 이슈 조회
issue_key = 'PROJ-123'  # 조회할 이슈 키
issue = jira.issue(issue_key)

# 이슈 정보 출력
print(f"Issue Key: {issue.key}")
print(f"Summary: {issue.fields.summary}")
print(f"Status: {issue.fields.status.name}")

위 코드는 PROJ-123이라는 이슈의 상세 정보를 가져와 출력합니다. fields 객체를 사용해 이슈의 다양한 속성(요약, 상태 등)에 접근할 수 있습니다.

2) JQL을 사용한 이슈 검색

JIRA에서는 JQL(JIRA Query Language)를 사용하여 복잡한 조건으로 이슈를 검색할 수 있습니다. 다음 코드는 JQL을 사용하여 특정 프로젝트의 모든 이슈를 검색하는 예입니다.

# JQL을 사용하여 이슈 검색
jql_query = 'project = PROJ AND status = "To Do"'
issues = jira.search_issues(jql_query)

# 검색된 이슈 출력
for issue in issues:
    print(f"Issue Key: {issue.key}, Summary: {issue.fields.summary}, Status: {issue.fields.status.name}")

이 코드는 특정 프로젝트(PROJ)의 상태가 “To Do”인 모든 이슈를 검색하여 출력합니다.

3) 이슈 생성

JIRA에서 새로운 이슈를 생성하는 것도 가능합니다. 아래 코드는 프로젝트에 새로운 Story 타입의 이슈를 생성하는 예입니다.

# 새로운 이슈 생성
new_issue = jira.create_issue(
    project='PROJ',
    summary='New Issue Summary',
    description='This is a new issue created via Python',
    issuetype={'name': 'Story'}
)

print(f"New issue created: {new_issue.key}")

위 코드는 프로젝트 키가 PROJ인 프로젝트에 새 이슈를 생성합니다. 이슈의 요약, 설명, 이슈 타입을 지정할 수 있습니다.

5. 이슈 업데이트

이미 생성된 이슈의 필드를 업데이트할 수도 있습니다. 다음은 이슈의 요약과 설명을 수정하는 예입니다.

# 이슈 업데이트
issue_key = 'PROJ-123'
issue = jira.issue(issue_key)

# 요약과 설명 업데이트
issue.update(
    summary='Updated Issue Summary',
    description='Updated issue description via Python'
)

print(f"Issue {issue_key} updated successfully")

위 코드는 특정 이슈의 요약과 설명을 업데이트합니다.

6. JIRA 프로젝트 정보 조회

JIRA API를 사용하여 프로젝트 정보를 가져올 수도 있습니다. 다음 코드는 JIRA 인스턴스에 있는 모든 프로젝트를 조회하는 예입니다.

# JIRA 인스턴스의 모든 프로젝트 조회
projects = jira.projects()

# 각 프로젝트 정보 출력
for project in projects:
    print(f"Project Key: {project.key}, Name: {project.name}")

이 코드는 JIRA의 모든 프로젝트를 조회하고, 프로젝트의 키와 이름을 출력합니다.

7. 에픽(Epic) 및 이슈 관계 관리

프로젝트 관리에서 에픽은 여러 이슈를 묶어서 관리하는 중요한 단위입니다. 에픽을 조회하고, 이슈를 에픽에 연결하는 방법을 살펴보겠습니다.

1) 에픽 조회

# 에픽 조회 (이슈 타입이 Epic인 이슈 검색)
epics = jira.search_issues('issuetype = Epic')

# 에픽 정보 출력
for epic in epics:
    print(f"Epic Key: {epic.key}, Summary: {epic.fields.summary}")

위 코드는 프로젝트에서 에픽 이슈를 검색하여 출력합니다.

2) 에픽에 이슈 연결

특정 이슈를 에픽에 연결하려면, 해당 이슈의 에픽 필드를 업데이트해야 합니다.

# 에픽에 이슈 연결
issue = jira.issue('PROJ-456')  # 에픽에 연결할 이슈
epic = jira.issue('PROJ-123')  # 연결할 에픽

issue.update(fields={'customfield_10011': epic.key})  # customfield_10011은 Epic Link 필드 ID
print(f"Issue {issue.key} linked to Epic {epic.key}")

위 예시에서 customfield_10011은 JIRA 인스턴스에 따라 에픽 링크 필드의 ID가 다를 수 있으니, 각 인스턴스에 맞는 필드를 확인해야 합니다.

8. 이슈 상태 변경

이슈의 상태를 변경하는 방법도 JIRA API를 통해 가능합니다. 이슈의 상태 변경은 워크플로우 전환(Transition)으로 처리됩니다.

# 가능한 전환 조회
issue_key = 'PROJ-123'
issue = jira.issue(issue_key)
transitions = jira.transitions(issue)

for transition in transitions:
    print(f"Transition ID: {transition['id']}, Name: {transition['name']}")

# 이슈 상태 전환
jira.transition_issue(issue, '5')  # 전환 ID를 사용해 상태 변경
print(f"Issue {issue_key} transitioned successfully")

이 코드는 이슈의 가능한 상태 전환 목록을 조회하고, 특정 전환 ID를 사용해 상태를 변경합니다.