nbQA-dev/nbQA

어떤 프로젝트인가요?

핵심 기능

• 01노트북 코드 셀에서 black, isort, ruff, flake8, mypy, pylint 등의 도구를 실행합니다
• 02blacken-docs 같은 도구로 마크다운 셀을 처리합니다
• 03노트북 코드가 깨지지 않도록 IPython 매직 명령을 처리합니다
• 04기존 도구 설정 파일을 따릅니다
• 05Jupytext 형식의 .md 노트북을 지원합니다
• 06pre-commit 훅 연동을 지원합니다

활용 사례

• 저장소의 데이터 과학 노트북 전반에 린트 및 포맷 표준을 적용합니다
• CI 파이프라인에서 mypy로 노트북의 타입을 검사합니다
• 커밋 전에 노트북 코드와 마크다운 문서를 자동으로 포맷합니다
• 오래된 노트북 모음 전체의 Python 구문을 업그레이드합니다

빠른 시작

1. 1

   가상 환경에 pip로 nbQA를 설치합니다

   python -m pip install -U nbqa
2. 2

   선택 사항으로 지원되는 모든 린터와 포매터를 설치합니다

   python -m pip install -U "nbqa[toolchain]"
3. 3

   예를 들어 black 같은 포매터를 노트북에 실행합니다

   nbqa black my_notebook.ipynb

사용 전 알아둘 점

• !toolchain extra를 사용하지 않는 한 각 린터 또는 포매터를 별도로 설치해야 합니다.

토픽

자주 묻는 질문

nbQA은(는) 무엇인가요?

Jupyter Notebook에서 ruff, isort, black, mypy, flake8 같은 Python 린터와 포매터를 바로 실행하는 CLI 도구입니다. nbQA를 사용하면 Jupyter Notebook을 먼저 스크립트로 변환하지 않고도 표준 Python 코드 품질 도구를 실행할 수 있습니다. 노트북의 코드 셀은 Python 코드로 검사하고, 마크다운 셀에는 blacken-docs 같은 도구를 적용할 수 있습니다. black, isort, pyupgrade, ruff, flake8, mypy, pylint, yapf, autopep8, pydocstyle, doctest 등 다양한 도구를 지원합니다.

nbQA은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?

nbQA은(는) MIT 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.

nbQA은(는) 아직 유지보수되고 있나요?

활발히 유지보수 중. nbQA의 마지막 커밋은 2026년 11월 6일입니다.

nbQA은(는) 어디에 사용할 수 있나요?

저장소의 데이터 과학 노트북 전반에 린트 및 포맷 표준을 적용합니다 CI 파이프라인에서 mypy로 노트북의 타입을 검사합니다 커밋 전에 노트북 코드와 마크다운 문서를 자동으로 포맷합니다 오래된 노트북 모음 전체의 Python 구문을 업그레이드합니다

nbQA는 어떻게 설치하나요?

가상 환경에 pip로 nbQA를 설치합니다: python -m pip install -U nbqa 선택 사항으로 지원되는 모든 린터와 포매터를 설치합니다: python -m pip install -U "nbqa[toolchain]" 예를 들어 black 같은 포매터를 노트북에 실행합니다: nbqa black my_notebook.ipynb

nbQA은(는) 어디서 받을 수 있나요?

소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/nbQA-dev/nbQA