GitHub에서 비공개 Python 패키지 생성 및 릴리스

소개

소프트웨어 엔지니어로서 우리는 다양한 모듈과 프로젝트에서 코드를 재사용하는 경우가 많습니다. 하지만 현실을 직시하자면 이러한 반복은 문제를 야기합니다. 해당 코드를 조정하거나 수정해야 할 때 여러 위치에서 동일한 변경을 수행해야 합니다. 효율성과 자동화를 중시하는 우리에게 해결책은 분명합니다. 프로젝트 전반에 걸쳐 설치하고 사용할 수 있는 별도의 패키지를 만드는 것입니다.
그러나 기밀 코드를 다룰 때 PyPI와 같은 공개 저장소에 패키지를 단순히 게시할 수는 없습니다. 대신 GitHub나 GitLab과 같은 개인 저장소에 배포해야 합니다. 이러한 접근 방식을 통해 보안을 유지하면서 재사용 가능한 패키지의 편리함을 누릴 수 있습니다.

이 튜토리얼에서는 다음 과정을 안내합니다.

1. Python 패키지 생성
2. 개인 저장소(GitHub)에 패키지 배포
3. 가상환경(venv)에 패키지 설치

이러한 단계를 따르면 코드 중복을 줄이고 프로젝트 전체에서 공유 코드의 유지 관리를 단순화할 수 있습니다.

참고: DRY는 "Don't Repeat Yourself"를 의미할 뿐만 아니라 라이프스타일 선택이기도 합니다.

1. 프로젝트 구조 설정

먼저 Python 패키지의 기본 프로젝트 구조를 설정해 보겠습니다.

my-package/
├── my_package/
│   ├── __init__.py
│   └── module1.py
├── setup.py
├── build.pipeline.yml
├── requirements.txt
├── .gitignore
├── README.md
├── MANIFEST.in
└── LICENSE

비공개 Python 패키지를 자세히 분석해 보겠습니다. 각 파일과 디렉터리는 패키지를 작동하고 설치 가능하게 만드는 데 중요한 역할을 합니다.

• my-package/: 이것은 우리 프로젝트의 루트 디렉터리입니다. 필요한 방(파일)이 모두 들어있는 집과 같습니다.
• my_package/: 이 하위 디렉터리는 실제 Python 코드가 있는 곳입니다. 명확성을 위해 패키지 이름과 동일하게 지정되었습니다.
  • __init__.py: 이 파일은 Python이 디렉터리를 패키지로 처리하도록 만듭니다. 비어 있거나 패키지의 초기화 코드를 실행할 수 있습니다.
  • module1.py: 여기에 메인 코드를 넣습니다. 패키지의 복잡성에 따라 여러 모듈 파일을 가질 수 있습니다.
• setup.py: 이것을 우리 패키지의 사용 설명서라고 생각하세요. 여기에는 패키지에 대한 메타데이터(예: 이름 및 버전)가 포함되어 있으며 종속성을 나열합니다. 이 파일은 pip를 통해 패키지를 설치할 수 있게 만드는 데 필수적입니다.
• 요구 사항.txt: 이 파일에는 프로젝트가 의존하는 모든 외부 Python 패키지가 나열되어 있습니다. 이는 패키지를 작동시키기 위해 무엇을 설치해야 하는지 정확하게 알려주는 pip 쇼핑 목록과 같습니다.
• README.md: 이것은 우리 프로젝트의 환영 매트입니다. 일반적으로 사람들이 GitHub 저장소를 방문할 때 가장 먼저 보게 되는 내용이므로 이를 사용하여 패키지의 기능, 설치 방법, 사용 방법을 설명합니다.
• .gitignore: 이 파일은 Git에게 무시할 파일이나 디렉터리를 알려줍니다. 컴파일된 코드, 임시 파일 또는 민감한 정보를 버전 관리에서 제외하는 데 유용합니다.
• 라이센스: 이 파일은 다른 사람들이 우리 패키지를 사용, 수정 또는 배포할 수 있는 방법을 지정합니다. 이는 오픈 소스 프로젝트에 매우 중요하며 작업을 보호하는 데 도움이 됩니다.
• MANIFEST.in: 이 파일은 패키지 배포에 Python이 아닌 파일을 포함하는 데 사용됩니다. 포함해야 할 데이터 파일, 문서 또는 기타 리소스가 있는 경우 여기에 나열합니다.
• build.pipeline.yml: 이 파일은 CI/CD(지속적 통합/지속적 배포) 파이프라인을 정의합니다. GitHub 저장소에 변경 사항을 푸시할 때 테스트 실행 및 패키지 빌드와 같은 작업을 자동화합니다.

2. 패키지 코드 생성

패키지 내에 간단한 모듈을 만들어 보겠습니다. my_package/module1.py에서:

my-package/
├── my_package/
│   ├── __init__.py
│   └── module1.py
├── setup.py
├── build.pipeline.yml
├── requirements.txt
├── .gitignore
├── README.md
├── MANIFEST.in
└── LICENSE

my_package/__init__.py에서 모듈을 가져옵니다.

class Hello:
    def __init__(self, name):
        self.name = name

    def greet(self):
        return f"Hello, {self.name}!"

3. setup.py 만들기

setup.py 파일은 프로젝트 패키징에 매우 중요합니다. 기본적인 예는 다음과 같습니다.

from .module1 import Hello

4. 요구 사항.txt 만들기

requirements.txt 파일에는 패키지를 빌드하고 배포하는 데 필요한 종속성이 포함되어 있습니다.

from setuptools import setup, find_packages

with open('requirements.txt') as f:
    requirements = f.read().splitlines()

setup(
    name="my_package",
    version="0.1",
    include_package_data=True,
    python_requires='>=3.8',
    packages=find_packages(),
    setup_requires=['setuptools-git-versioning'],
    install_requires=requirements,
    author="Abdellah HALLOU",
    author_email="abdeallahhallou33@gmail.com",
    description="A short description of your package",
    long_description=open('README.md').read(),
    long_description_content_type="text/markdown",
    classifiers=[
        "Programming Language :: Python :: 3.8",
        "License :: OSI Approved :: MIT License",
        "Operating System :: OS Independent",
    ],
    version_config={
       "dirty_template": "{tag}",
    }
)

5. 패키지 빌드 및 설치

요구사항을 설치하세요. 작업을 단순화하기 위해 Python 가상 환경을 사용하겠습니다.

setuptools==69.2.0
wheel
twine

패키지를 구축하려면:

python -m venv env
source env/bin/activate # for linux and mac
./env/Scripts/activate # for windows
pip install -r requirements.txt

테스트를 위해 패키지를 로컬에 설치하려면:

python setup.py sdist bdist_wheel

.gitignore 파일을 사용하여 작업을 커밋하고 폴더를 무시할 수 있습니다.

https://github.com/github/gitignore/blob/main/Python.gitignore

6. 태그를 사용하여 GitHub에 패키지 게시

패키지를 게시하려면 먼저 my-package/ 프로젝트의 루트에 build.pipeline.yml 파일을 생성하고 커밋합니다. 배포는 이전에 설치한 라이브러리인 Twine을 사용하여 수행됩니다.

my-package/
├── my_package/
│   ├── __init__.py
│   └── module1.py
├── setup.py
├── build.pipeline.yml
├── requirements.txt
├── .gitignore
├── README.md
├── MANIFEST.in
└── LICENSE

모듈 설치에 Python이 아닌 파일을 포함해야 하는 경우 MANIFEST.in 파일을 사용할 수 있습니다. 이 파일은 패키지 배포에 포함되어야 하는 추가 파일을 지정합니다.

class Hello:
    def __init__(self, name):
        self.name = name

    def greet(self):
        return f"Hello, {self.name}!"

그런 다음 패키지를 업로드하세요.

from .module1 import Hello

7. 패키지 설치

액세스 토큰 만들기:

• 설정으로 이동 > 개발자 설정 > 개인 액세스 토큰(클래식) > 새 토큰을 생성.
• 필요한 권한을 부여하려면 write:packages 범위를 확인하세요.

토큰을 받은 후에는 패키지를 설치할 때 필요하므로 안전하게 보관하세요.

컴퓨터에서 다음 템플릿을 사용하여 개인 패키지를 설치할 수 있습니다.

from setuptools import setup, find_packages

with open('requirements.txt') as f:
    requirements = f.read().splitlines()

setup(
    name="my_package",
    version="0.1",
    include_package_data=True,
    python_requires='>=3.8',
    packages=find_packages(),
    setup_requires=['setuptools-git-versioning'],
    install_requires=requirements,
    author="Abdellah HALLOU",
    author_email="abdeallahhallou33@gmail.com",
    description="A short description of your package",
    long_description=open('README.md').read(),
    long_description_content_type="text/markdown",
    classifiers=[
        "Programming Language :: Python :: 3.8",
        "License :: OSI Approved :: MIT License",
        "Operating System :: OS Independent",
    ],
    version_config={
       "dirty_template": "{tag}",
    }
)

결론

잘하셨습니다. 이제 GitHub에서 Python을 사용하여 자신만의 비공개 패키지를 만들고 배포하는 방법을 알게 되었습니다.

Github 저장소 링크: https://github.com/ABDELLAH-Hallou/Private-Python-Package-Deployment

위 내용은 GitHub에서 비공개 Python 패키지 생성 및 릴리스의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!