Repolode
제출하기
mkdocstrings

mkdocstrings/griffe

Python 패키지의 구조와 시그니처를 추출해 API 문서를 생성하거나 호환성을 깨는 변경을 감지하는 도구입니다.

GitHub에서 보기웹사이트
스타
704
포크
81
열린 이슈
41
마지막 커밋
15일 전

어떤 프로젝트인가요?

Griffe는 Python 패키지를 불러와 코드를 실행하지 않고도 모듈, 클래스, 함수, 시그니처를 구조화된 형태로 표현합니다. 결과는 JSON으로 직렬화하거나 Python에서 탐색할 수 있어 문서 생성기의 데이터 소스로 활용하기 좋습니다.

CLI에는 두 가지 주요 명령이 있습니다. `griffe dump`는 하나 이상의 패키지 API를 JSON으로 내보내고, `griffe check`는 현재 코드를 이전 버전과 비교해 매개변수 종류 변경과 같은 호환성을 깨는 변경을 보고합니다. 기준 버전은 git ref나 PyPI에 공개된 릴리스에서 불러올 수 있으며, `src` 레이아웃도 지원합니다.

Griffe는 pip 또는 uv로 설치할 수 있습니다. Python API는 스크립트에서 검사를 실행하거나 사용자 지정 도구를 만들 때 사용할 수 있는 `load`, `load_git`, `find_breaking_changes`를 제공합니다.

핵심 기능

  • 01Python 패키지의 구조와 시그니처를 정적으로 추출합니다.
  • 02`griffe dump`로 API를 JSON으로 내보냅니다.
  • 03git ref와 비교하는 기능을 포함해 `griffe check`로 호환성을 깨는 변경을 감지합니다.
  • 04pypi extra를 사용해 PyPI에서 가져온 릴리스와 비교할 수 있습니다.
  • 05패키지를 불러오고 호환성을 깨는 변경을 찾는 Python API를 제공합니다.

활용 사례

  • Python 라이브러리의 API 레퍼런스 문서를 생성합니다.
  • 릴리스 전에 CI에서 의도치 않은 시그니처 변경을 찾아냅니다.
  • 새 릴리스를 PyPI의 이전 버전과 비교합니다.
  • 코드베이스의 공개 API를 검사하는 사용자 지정 도구를 만듭니다.

빠른 시작

  1. 1

    pip으로 Griffe 설치하기

    pip install griffe
  2. 2

    패키지의 API를 JSON 형식으로 덤프하기

    griffe dump httpx fastapi
  3. 3

    패키지에 API 호환성을 깨는 변경 사항이 있는지 확인하기

    griffe check mypackage --verbose

사용 전 알아둘 점

  • PyPI 패키지를 확인하려면 선택 사항인 pypi extra가 필요합니다.

토픽

#python#api-documentation#breaking-changes#static-analysis#developer-tools#docs#api#mkdocstrings-collector#parser#signature

자주 묻는 질문

griffe은(는) 무엇인가요?
Python 패키지의 구조와 시그니처를 추출해 API 문서를 생성하거나 호환성을 깨는 변경을 감지하는 도구입니다. Griffe는 Python 패키지를 불러와 코드를 실행하지 않고도 모듈, 클래스, 함수, 시그니처를 구조화된 형태로 표현합니다. 결과는 JSON으로 직렬화하거나 Python에서 탐색할 수 있어 문서 생성기의 데이터 소스로 활용하기 좋습니다.
griffe은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?
griffe은(는) ISC 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.
griffe은(는) 아직 유지보수되고 있나요?
활발히 유지보수 중. griffe의 마지막 커밋은 2026년 10월 23일입니다.
griffe은(는) 어디에 사용할 수 있나요?
Python 라이브러리의 API 레퍼런스 문서를 생성합니다. 릴리스 전에 CI에서 의도치 않은 시그니처 변경을 찾아냅니다. 새 릴리스를 PyPI의 이전 버전과 비교합니다. 코드베이스의 공개 API를 검사하는 사용자 지정 도구를 만듭니다.
griffe는 어떻게 설치하나요?
pip으로 Griffe 설치하기: pip install griffe 패키지의 API를 JSON 형식으로 덤프하기: griffe dump httpx fastapi 패키지에 API 호환성을 깨는 변경 사항이 있는지 확인하기: griffe check mypackage --verbose
griffe은(는) 어디서 받을 수 있나요?
소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/mkdocstrings/griffe

요약은 프로젝트 README를 바탕으로 AI가 작성했습니다. GitHub 통계는 매일 갱신됩니다.

관련 프로젝트