cookiecutter hatch pypackage

cookiecutter hatch pypackage

최첨단 Python 패키지용 Cookiecutter 템플릿: Hatch , ruff , mypy , GitHub Actions 등!

세부
특징

특징

• 경량 스타터
• Hatch 패키지 관리
• atch-vcs: git 태그에서 자동으로 패키지 버전을 확인합니다(예: v0.9
• isort, flake8, black 등을 대체하는 ruff 로 린팅 및 서식 지정
• mypy 로 유형 확인하기
• deptry 사용하여 사용되지 않거나 누락된 종속성 및 전이적 종속성을 확인하세요.
• 선택적 asyncio 설정을 사용하여 pytest 사용한 단위 테스트입니다.
• Hatch-env-matrix를 사용하여 테스트 자동화 및 표준화
• MkDocs용 자료가 포함된 문서화 및 mkdocstrings를 통한 docstring 참조 지원.
• dependabot , release-drafter , labeler , publish to PYPI workflows , publish to test PYPI workflows 등을 포함하는 즉시 사용 가능한 GitHub Actions 파이프라인.
• 해치-pip-컴파일: 잠금 파일에 대한 실험적 지원,
• pyproject.toml: 하나의 파일에 모든 패키지, 빌드 및 도구 구성,
• 커버리지: pytest 통합으로 Python 프로그램의 코드 커버리지를 측정하기 위한 도구,
• 사전 커밋: 삶을 더 쉽게 만들어주는 사전 커밋 git 후크
• Markdown: reStructuredText 대신 Markdown이 모든 텍스트 파일에 일관되게 사용됩니다.
• EditorConfig: 여러 개발자를 위해 일관된 코딩 스타일을 유지합니다.
• src-layout: 실제 Python 패키지는 많은 일반적인 오류를 방지하기 위해 src 폴더 아래에 보관됩니다.

? 빠른 시작

프로젝트를 생성합니다.

이 프로젝트에서는 pipx 사용하여 격리된 환경에 hatch 설치합니다. 다음 명령을 실행하기 전에 pipx 설치되어 있는지 확인하십시오.

cookiecutter https://github.com/Aviksaikat/cookiecutter-hatch-pypackage

생성기는 마지막에 자동으로 hatch env create & git init 호출합니다.

그런 다음 GitHub Actions pipelines 올바르게 작동하려면 다음을 수행해야 합니다.

• Codecov 에서 GitHub 저장소를 활성화합니다.
• GitHub 저장소 비밀에 CODECOV_TOKEN 설정하세요. 해당 프로젝트의 Codecov 설정에서 찾을 수 있습니다.
• GitHub Actions 소스를 사용하여 GitHub Pages 활성화합니다.
• 테스트를 위해 테스트 PyPI 에 게시하는 옵션입니다.
• PyPI에서 신뢰할 수 있는 게시자 방법을 구성합니다. 이는 패키지를 PyPI에 푸시하는 현대적이고 안전한 방법입니다.

크러프트와 함께

cruft는 Cookiecutter 위의 레이어로, 생성된 후 템플릿에서 프로젝트를 업데이트할 수 있습니다.

cruft create https://github.com/Aviksaikat/cookiecutter-hatch-pypackage

데모

특허

이 프로젝트는 MIT 라이선스 조건에 따라 라이선스가 부여됩니다.