bootstrap python package

부트 스트랩 파이썬 패키지

이 템플릿 저장소는 보일러 플레이트를 제공하여 파이썬 패키지를 생성합니다. 다음 모든 기능으로 구성됩니다.

• Tox 및 Pytest를 사용한 테스트 스위트
• mypy를 사용하여 타이핑
• Ruff를 사용한 Linting, Security 및 Code Format (검은 색 코드 스타일 및 산적 보안 규칙 사용)
• 코드 품질 및 커버리지 점검을위한 CodeClimate와 통합
• CI 파이프 라인 지원 :
  • 여러 파이썬 버전에 대한 테스트
  • PYPI를 출시합니다
  • MKDocs를 사용한 GitHub 페이지 문서
• Pycharm 프로파일 기본 구성

이 저장소 템플릿을 사용하여 새 패키지를 만드는 방법

• 이 템플릿을 사용하여 github 저장소를 만듭니다. (Big Green 이이 Use this template )
• bootstrap_python_package 디렉토리의 이름을 바꿉니다
• bootstrap-python-package 및 bootstrap_python_package 의 모든 발생을 검색하고 교체하십시오.
• 다음 값을 사용하여 PYPI에서 신뢰할 수있는 신뢰할 수있는 게시자를 구성하십시오.
  • PYPI 프로젝트 이름 : Github 리포지토리 이름 (이 경우 bootstrap-python-package )
  • 소유자 : Github 저장소 소유자 (이 경우 febus982 )
  • 저장소 이름 : GitHub 리포지토리 이름 (이 경우 bootstrap-python-package )
  • 워크 플로 이름 : release.yml
• CODECLIMATE_REPORTER_ID 라는 GitHub Actions 비밀을 만듭니다 (at https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/secrets/actions ) CodeClimate Reporter id ( https://codeclimate.com/repos/YOUR_REPO_ID/settings/test_reporter ) ). CodeClimate를 사용하지 않으려면 workflows/python-quality.yml 삭제하십시오.
• README.md 에서 배지를 업데이트하십시오! (추가 배지에 대한 shields.io 확인)
• IDE 설정에서 Pycharm 저작권 프로필 업데이트 : 편집기 | 저작권 | 저작권 프로파일 (사용하려는 경우)
• 로컬 개발 설정 :
  • 저장소를 복제하십시오
  • 시를 설치하는 pip install poetry
  • make dev-dependencies DEV 종속성을 설치하십시오
  • (선택 사항) git commit 중에 포맷 및 라인이 자동으로 실행되도록 사전 커밋 및 실행 pre-commit install 설치하는 것이 좋습니다.
• GitHub 페이지 설정 (이로 인해 로컬 개발 설정이 필요합니다) :
  • 초기화 문서화 지점 poetry run mike deploy dev latest --update-aliases --push
  • gh-pages 브랜치에서 배포 할 gitHub 페이지를 구성합니다 (url https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/pages )
  • main 분기와 v*.*.* gh-pages https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/environments

중요 : 리포지토리는 테스트 PYPI 저장소에 배포되도록 구성됩니다. 테스트 PYPI 저장소에서 프로젝트를 작성하고 배포 파이프 라인을 테스트하는 것이 좋습니다. 결과에 만족하면 공식 PYPI 저장소에서 프로젝트를 작성하고 workflows/release.yml 에서 표시된 라인을 제거하십시오.

패키지 릴리스

이 설정은시 방향 버전을 사용합니다. 즉, 코드에서 버전을 커밋 할 필요는 없지만 CI 파이프 라인은 GIT 태그에서 추론합니다.

새 버전을 출시하려면 새 릴리스를 만들고 GitHub 저장소에서 다음과 같이 표시하십시오.

• Python 패키지를 PYPI에 빌드 및 배포하십시오
• GitHub 페이지에 새 버전의 문서를 빌드 및 배포하십시오.

중요 : 기본 구성에는 릴리스 이름과 태그가 컨벤션 vX.XX 따라야합니다 (Semantic 버전은 소문자 v 에 앞서 있습니다). PYPI에 올바른 버전을 게시하여 v 생략합니다 (예 : v1.0.0 1.0.0 게시합니다).

이 형식은 사용자 정의 할 수 있습니다.시-디아마크 배전 문서를 참조하십시오

개발 명령

개발 중에 사용 된 모든 일반적인 명령은 MAKE TARGETS를 사용하여 실행할 수 있습니다.

• make dev-dependencies
• make update-dependencies : DEV 요구 사항을 업데이트하십시오
• make fix : 코드 스타일 및 보풀 자동 수정 실행 (가능한 경우)
• make test : 시스템 파이썬 버전에서 테스트 스위트 실행
• make check : 사용 가능한 모든 Python 버전, 코드 스타일 및 보풀 확인에 대한 테스트 실행
• make type , make format , make lint , make bandit : 관련 점검을 실행하십시오.
• make docs : MKDocs 웹 사이트를 로컬로 렌더링하십시오