[Python Cheatsheet] 62. Packaging - pyproject.toml/배포 체크리스트

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

[build-system]
requires = ["setuptools>=61.0", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "my-package"
version = "0.1.0"
description = "A short description"
readme = "README.md"
license = {text = "MIT"}
authors = [
    {name = "Your Name", email = "you@example.com"}
]
requires-python = ">=3.8"

# 의존성
dependencies = [
    "requests>=2.28",
    "click>=8.0",
]

# 선택적 의존성 (pip install my-package[dev])
[project.optional-dependencies]
dev = [
    "pytest>=7.0",
    "black",
    "mypy",
]

# CLI 엔트리포인트
[project.scripts]
my-cli = "my_package.cli:main"

[project.urls]
Homepage = "https://github.com/you/my-package"
Documentation = "https://my-package.readthedocs.io"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

# 필요 도구 설치
pip install build twine

# 빌드 (dist/ 폴더 생성)
python -m build

# TestPyPI에 먼저 테스트 업로드
twine upload --repository testpypi dist/*

# TestPyPI에서 설치 테스트
pip install --index-url https://test.pypi.org/simple/ my-package

# 실제 PyPI 업로드
twine upload dist/*

1
2
3
4
5

# 소스 코드 변경이 바로 반영됨
pip install -e .

# 선택적 의존성 포함
pip install -e ".[dev]"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

my-package/
├── pyproject.toml
├── README.md
├── LICENSE
├── src/
│   └── my_package/
│       ├── __init__.py
│       ├── core.py
│       └── cli.py
└── tests/
    └── test_core.py

1
2
3

# src 레이아웃 사용 시 추가 설정
[tool.setuptools.packages.find]
where = ["src"]