Poetry 설치
Poetry를 사용하기 위해 먼저 설치해야 합니다. 아래의 명령어를 사용하여 Poetry를 설치합니다.
$ pip install poetry
프로젝트 생성
Poetry를 사용하여 새로운 프로젝트를 생성합니다. 프로젝트 폴더로 이동한 후에 다음 명령어를 실행합니다.
$ poetry new myproject
위 명령어를 실행하면 myproject라는 이름의 새로운 폴더가 생성되며, Poetry에서 필요한 파일과 폴더 구조가 포함됩니다.
의존성 관리
Poetry를 사용하면 프로젝트의 의존성을 관리할 수 있습니다. pyproject.toml 파일에 프로젝트의 의존성을 명시합니다. 예를 들어, requests 패키지를 사용하고 있다면, pyproject.toml 파일에서 다음과 같이 설정할 수 있습니다.
[build-system]
requires = ["python>=3.9"]
build-backend = "poetry.masonry.api"
[tool.poetry.dependencies]
python = "^3.9"
requests = "^2.26.0"
의존성을 추가한 후에는 poetry install 명령어로 의존성을 설치할 수 있습니다.
$ poetry install
문서화
Poetry는 문서화를 위한 툴인 MkDocs를 내장하고 있습니다. 다음 명령어를 사용하여 MkDocs를 설치합니다.
$ poetry add mkdocs --dev
MkDocs를 설치한 후에는 mkdocs.yml 파일을 생성하여 문서화 설정을 할 수 있습니다.
site_name: MyProject
theme: readthedocs
위와 같이 site_name과 theme 설정을 추가한 후에는 문서화를 시작할 수 있습니다.
$ poetry run mkdocs new docs
$ cd docs
위 명령어를 실행하여 docs 폴더를 생성한 후에 문서화 작업을 진행할 수 있습니다.
주석 작성
Poetry는 주석 작성을 위한 도구인 Sphinx도 지원합니다. Sphinx를 사용하여 자동으로 문서를 생성하고 주석을 작성할 수 있습니다.
$ poetry add sphinx --dev
위 명령어를 사용하여 Sphinx를 설치한 후에는 sphinx-quickstart 명령어로 프로젝트 설정을 시작할 수 있습니다.
$ poetry run sphinx-quickstart
위 명령어를 실행하면 프로젝트에 필요한 설정들을 진행할 수 있습니다. 이후에는 주석을 작성하고 문서를 생성할 수 있습니다.
마무리
Poetry를 사용하면 파이썬 패키지의 의존성 관리와 문서화 작업을 효과적으로 수행할 수 있습니다. 의존성을 명시적으로 관리하고, MkDocs와 Sphinx를 활용하여 문서화를 진행할 수 있습니다. Poetry의 강력한 기능들을 사용하여 프로젝트를 보다 효율적으로 관리해보세요.
참조: