파이썬 패키지에 .gitignore 파일 추가하기

지난번 패키지에 라이센스 추가하는 방법에 이어 .gitignore파일을 추가해보려한다.

.gitignore 란

.gitignore는 깃허브에 push 하는 파일중에서 특정파일은 제외하고 싶은 경우에 사용하는데, 예를 들면 vscode를 사용하는 경우 .vscode 폴더 라던지, id/pwd가 포함된 파일이라던지,cache 폴더 같은 것들을 제외하기 위한 방법이다.

repository만들 때 .gitignore를 추가할 수 있다

처음 만들 때 .gitignore파일을 넣지 않은 경우는 직접 파일을 업로드 해줘야 한다. 그런 경우 깃 허브에서 제공하는 gitignore 파일을 (링크) 추가해 주면 새로 추가 해줄 수 있다.

아무래도 좀더 프로패셔널하고 공식적인 라이브러리 성격을 지니는 git을 만들려면 꼭 추가해주는 게 좋을 것 같으므로…

.gitignore 추가하기 (그림일기)

https://github.com/github/gitignore 접속

Python.gitignore 클릭

Raw 눌러서 전체 내용복사 (하이라이트는 내가관심있는 제외 리스트)

Create new file 클릭 (하이라이트는 ignore될 것으로 예상되는 파일)

새로운 .gitignore를 Python.gitignore에서 복붙하고 추가

깃허브를 Pull 해주면

.gitignore파일이 추가된 것을 볼 수 있다

하지만 이제와서 push를 한다고 해도, 기존의 깃허브에 있는 파일은 깃에서 트래킹을 하고 있기 때문에, 아래와 같이 git으로 지워줘야 한다(링크)

따라서 git bash 를 실행하고 git repo 위치에가서 아래 코드를 입력

git init
git rm -r --cached .
git add .
git commit -m "Apply .gitignore"
git push

실행 결과

dist 폴더와 .egg-info 가 push되지 않았다(.gitignore 적용)

setup.py 에서 버전을 올려주고 push

그럴듯 하게 README 파일도 업데이트 후 push

• 패키지 업그래이드

python setup.py bdist_wheel
twine upload dist\ypcc-0.4-py3-none-any.whl

PyPI 패키지에 v0.4 배포

gitignore추가하여 v0.4 버전 완료

v0.1 에서는 아주 기본적인 패키징을 했고

v0.2 에서는 단순 버전업을 진행

v0.3 에서는 라이센스 파일을 추가 하는 법

v0.4 에서는 .git ignore 파일을 추가 하는 법 (이 포스트)

v0.5 에서는 requirements.txt파일을 추가하는 법을 해볼까? (예정)

끝