Skip to main content

Smart Pull Request Generator

Smart Pull Request Generator는 GitHub와 JIRA를 통합하여 스마트한 풀 리퀘스트를 생성하는 도구입니다. 이 도구는 개발자가 더 효율적으로 작업할 수 있도록 돕습니다.

설치 방법

설치하기

pip install --upgrade smart-pr-generator

로컬에 CLI 설치하기

다음 명령어를 사용하여 로컬에 설치할 수 있습니다:

pip install .

# 개발 모드로 설치
pip install -e .

GitHub에서 설치하기

GitHub 저장소에서 직접 설치하려면 다음 명령어를 사용하세요:

pip install git+https://github.com/jeongsk/Smart-PR-Generator.git

필수 설정

GitHub 토큰 발급 받기

GitHub 토큰을 발급 받으려면 GitHub 토큰 설정 페이지로 이동하세요.

JIRA API 토큰 발급 받기

JIRA API 토큰을 발급 받으려면 JIRA API 토큰 설정 페이지로 이동하세요.

환경 변수 설정

다음 환경 변수를 설정해야 합니다:

export SMART_PR_GENERATOR_API_KEY="LAAS API KEY"

export GITHUB_TOKEN="개인 깃허브 토큰"

export JIRA_EMAIL="지라 개인 이메일 주소"
export JIRA_API_TOKEN="지라 개인 API 액세스 토큰"

환경 변수를 설정하는 방법은 세 가지가 있습니다:

  1. ~/.zshrc 파일에 환경 변수를 추가합니다.
  2. ~/.smart-pr-generator 파일을 생성하고 위의 환경 변수를 추가합니다.
  3. 프로젝트 루트에 .env 파일을 생성하고 위의 환경 변수를 추가합니다.

프로젝트 구조

  • smart_pr_generator/: 주요 소스 코드가 포함된 디렉토리입니다.
    • __init__.py: 패키지 초기화 파일입니다.
    • agents.py: 에이전트 관련 기능을 포함합니다.
    • config.py: 설정 관련 기능을 포함합니다.
    • main.py: 프로그램의 진입점입니다.
    • prompts.py: 사용자 프롬프트 관련 기능을 포함합니다.
    • tools.py: 도구 관련 기능을 포함합니다.
    • helpers/: 보조 기능을 포함한 디렉토리입니다.
      • __init__.py: 보조 기능 초기화 파일입니다.
      • get_git_info.py: Git 정보 수집 기능을 포함합니다.
      • github_client.py: GitHub 클라이언트 기능을 포함합니다.
      • is_tool_calling.py: 도구 호출 여부를 확인하는 기능을 포함합니다.
      • jira_client.py: JIRA 클라이언트 기능을 포함합니다.
  • tests/: 테스트 코드가 포함된 디렉토리입니다.
    • test_main.py: 메인 기능에 대한 테스트를 포함합니다.

사용 예시

설치 및 환경 변수 설정 후, 다음과 같은 명령어로 Smart Pull Request Generator를 사용할 수 있습니다:

# 사용 명령어 Pull Request
$ spr

기여하기

기여를 원하신다면, 이 저장소를 포크하고 풀 리퀘스트를 보내주세요. 기여는 언제나 환영입니다!

라이선스

이 프로젝트는 MIT 라이선스 하에 배포됩니다. 자세한 내용은 LICENSE 파일을 참조하세요.

Metadata

Release files for smart-pr-generator 0.1.15

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for smart-pr-generator 0.1.15
File Size Uploaded Provenance
smart_pr_generator-0.1.15.tar.gz 11.4 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for smart-pr-generator 0.1.15
File Interpreter ABI Platform
smart_pr_generator-0.1.15-py3-none-any.whl Python 3 none any Details

Total release size: 25.9 kB

Release files / smart_pr_generator-0.1.15.tar.gz

Download URL smart_pr_generator-0.1.15.tar.gz
Size 11.4 kB
Tags Source
SHA-256 checksum
How to use checksums
40c74376b9110c9e4d7a3267b3864d8c26e474796cead709881f80520964f8e4
BLAKE2b-256 checksum
How to use checksums
97525bce30f143d857ae7163de0b44a117b37a5b1095caba9f9f9f8234baffc1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.11.9

Release files / smart_pr_generator-0.1.15-py3-none-any.whl

Download URL smart_pr_generator-0.1.15-py3-none-any.whl
Size 14.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a1c3644f28222c059d666051428e7fcd6d6763b7704056d99bd69a404e7df8a2
BLAKE2b-256 checksum
How to use checksums
bbeb5a09c13dd0ba450d3d1f7b38d01b296147a9efc5991e0791660d83e0fc1c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.11.9

Security for smart-pr-generator 0.1.15

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page