[repository setup] packaging 관련 파일 - setup.py, setup.cfg 란?

repository 저장소를 처음 setup 할때 필요한 것들에 대해 정리해보자 한다. (기억력이 안좋은 미래의 나를 위해..)

 

먼저 package화를 시키기 위해 필요한 파일들이 있다. 패키지화를 왜 하느냐? 나중에 배포를 쉽게 하려고

 

1. setup.py : 나중에 만들 패키지에 대한 설명과 함께 패키지에 어떤 파일들과 모듈들이 포함되어 있어야하는지 설명해주는 파일

from setuptools import setup, find_namespace_packages
setup(
    name='test',
    version='0.0.1',
    description='test',
    author='xxx',
    author_email='xxx',
    url='https://www.com',
    packages=find_namespace_packages(include=['test.*']),
    install_requires=[
        "pandas",
        "pytest",
    ],
)

패키지에 대한 기본적인 설명이 있다. packages 에 test.* 라고 작성된 것은 test로 시작하는 모든 파일들, test.xxx 들을 패키지에 포함시키라는 뜻

그리고 이 패키지를 install 하기 위해 필요한 라이브러리 리스트도 있다.

반응형

2. setup.cfg : setup.py에 대해 좀 더 자세히 옵션을 설정해주는 파일

예를들어 파일을 commit하기 전에 precommit 으로 flake8이라는 코드를 lint(정리) 해주는 라이브러리를 사용하는데, 몇가지 제외시켜주고 싶은 에러가 있다고 해보자. 예를들어 문장을 길게 써서 나타나는 에러때문에 commit을 못하고 싶지는 않다. 그래서 구체적으로 이 에러인 경우에는 그냥 ignore 시켜줘 라는 옵션을 설정했다.

이런식으로 setup.cfg 에는 내 패키지에 옵션을 구체적으로 적을 수 있다. metadata 같은 것도 여기에 적을 수 있다.

[flake8]
ignore =
    # Line 이 너무 긴 경우 생기는 에러
    E501

 

 

---

배움을 기록하기 위한 공간입니다. 

수정이 필요한 내용이나 공유하고 싶은 것이 있다면 언제든 댓글로 남겨주시면 환영입니다 :D