[python3.10 기본] 26. 다양한 도구와 기법

26.1 문서화 도구 (Sphinx)

Sphinx는 파이썬 프로젝트의 문서를 생성하는 도구입니다. Sphinx를 사용하면 코드 주석을 기반으로 HTML, PDF 등의 문서를 생성할 수 있습니다.

Sphinx 설치

pip install sphinx

Sphinx 설정
프로젝트 디렉토리에서 Sphinx 설정을 초기화합니다. 설정 과정에서 몇 가지 질문에 답하고 나면, conf.py 파일이 생성됩니다.

sphinx-quickstart

자동화된 문서화
autodoc 확장을 사용하여 코드 주석을 기반으로 자동 문서를 생성할 수 있습니다.

# conf.py
extensions = [
    'sphinx.ext.autodoc',
]

문서 생성

sphinx-apidoc -o docs/source/ my_project/
sphinx-build -b html docs/source/ docs/build/html

26.2 코드 품질 검사 도구 (pylint, flake8)

코드 품질 검사 도구를 사용하면 코드 스타일과 일관성을 유지하고, 잠재적인 버그를 발견할 수 있습니다.

pylint

pylint 설치

pip install pylint

pylint 사용

pylint my_module.py

flake8

flake8 설치

pip install flake8

flake8 사용

flake8 my_module.py

26.3 버전 관리 (git 기본 사용법)

Git은 버전 관리를 위한 분산형 시스템입니다. Git을 사용하면 코드의 변경 내역을 추적하고, 여러 사람이 협업할 수 있습니다.

Git 설치

• Windows: Git for Windows에서 다운로드
• macOS: Homebrew를 사용하여 설치 
• brew install git
• Linux: 패키지 관리자를 사용하여 설치

  sudo apt-get install git

Git 기본 명령어

저장소 초기화

git init

파일 추가 및 커밋

git add myfile.py
git commit -m "Initial commit"

원격 저장소 추가

git remote add origin https://github.com/yourusername/yourrepository.git

커밋 푸시

git push -u origin master

변경 내역 확인

git log

브랜치 생성 및 이동

git checkout -b new_feature

병합

git checkout master
git merge new_feature

클론

git clone https://github.com/yourusername/yourrepository.git