pyscaffold/pyscaffold

어떤 프로젝트인가요?

핵심 기능

• 01setup.cfg 기반 설정을 사용하는 src 레이아웃의 Python 패키지를 생성합니다.
• 02setuptools_scm을 통해 Git 태그에서 버전 번호를 추론합니다.
• 03PyPI 빌드 및 배포를 위한 tox 작업을 미리 설정합니다.
• 04pytest와 pytest-cov 설정, Sphinx 문서 디렉터리를 포함합니다.
• 05선택적으로 pre-commit 훅, Cirrus CI 파일, 라이선스 선택을 지원합니다.
• 06`putup --update`로 기존 스캐폴드를 업데이트할 수 있습니다.

활용 사례

• PyPI에 배포할 새 Python 라이브러리를 시작할 때.
• 팀의 Python 프로젝트 전반에서 패키지 레이아웃과 도구를 표준화할 때.
• 기존 Git 저장소를 패키징과 문서가 갖춰진 Python 프로젝트로 변환할 때.

빠른 시작

1. 1

   pip으로 PyScaffold 설치하기

   pip install pyscaffold
2. 2

   putup으로 새 프로젝트 만들기

   putup my_project
3. 3

   프로젝트 디렉터리로 이동해 editable mode로 설치하기

   pip install -e .

사용 전 알아둘 점

• !README에는 최신 버전이 v4로 나와 있으며, 이전 안정 버전은 v3.3입니다.
• !PyScaffold를 사용하려면 Git을 설치하고 이름과 이메일 주소를 설정해야 합니다.

토픽

자주 묻는 질문

pyscaffold은(는) 무엇인가요?

tox, pytest, Sphinx 문서, Git 버전 관리를 미리 설정해 설치 및 PyPI 배포가 가능한 패키지의 기본 구조를 만드는 Python 프로젝트 생성기입니다. PyScaffold는 Python 프로젝트를 생성하는 명령줄 도구입니다. `putup my_project`를 실행하면 setup.cfg 기반 설정, src 레이아웃, tests 폴더, Sphinx 문서 디렉터리를 갖춘 패키지 기본 구조가 만들어집니다. 따라서 보일러플레이트를 직접 작성하지 않고도 새 라이브러리를 빌드하고 테스트한 뒤 배포할 수 있습니다.

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

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

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

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

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

PyPI에 배포할 새 Python 라이브러리를 시작할 때. 팀의 Python 프로젝트 전반에서 패키지 레이아웃과 도구를 표준화할 때. 기존 Git 저장소를 패키징과 문서가 갖춰진 Python 프로젝트로 변환할 때.

pyscaffold는 어떻게 설치하나요?

pip으로 PyScaffold 설치하기: pip install pyscaffold putup으로 새 프로젝트 만들기: putup my_project 프로젝트 디렉터리로 이동해 editable mode로 설치하기: pip install -e .

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

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