본문 바로가기
Programming

Python을 위한 gitignore

by 느리게 걷는 즐거움 2022. 4. 7.
반응형

파이썬을 개발하면 디버깅을 위해 생성되는 *.pyc파일이나 log파일등 git에 업데이트가 필요없는 파일들이 생성됩니다.

이 경우 이런 파일들은 git을 통한 이력관리 대상에서 제거되어야 개발에 편리합니다.

 

테스트를 위해 작성한 파일이긴 하지만 아래와 같이 로그와 pyc파일이 점점 많아지면 개발에 불편한 점이 많아집니다.

 

이렇게 git에서 이력관리가 필요없는 파일들에 대해서 tracking을 제외하기 위해서 .gitignore파일을 사용합니다.

 

.gitignore 파일생성

.gitignore파일은 초기에 git을 생성한 후 자신이 만들어야 하는 파일입니다. 로컬 git 저장소의 가장 상위 폴더에 생성합니다. github에서는 여러 개발자들이 이력관리가 필요없다고 생각되는 파일들을 업데이트하고 있습니다.

 

https://github.com/github/gitignore

 

GitHub - github/gitignore: A collection of useful .gitignore templates

A collection of useful .gitignore templates. Contribute to github/gitignore development by creating an account on GitHub.

github.com

 

위의 github의 파일 중 python에 해당하는 파일을 다운로드해서 사용하면 좋을 것 같습니다. .gitignore파일을 보면 어떤 걸 개발하는 지에 따라서 업데이트된 제외파일들이 다릅니다. Django로 주석표시된 제외 파일은 아래와 같습니다.

 

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Sphinx documentation
docs/_build/

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

 

Django의 경우 db파일과 로그파일들을 제외하고 있고 문서화를 위한 Sphinx에 대한 제외 파일들도 있습니다. 위의 .gitignore파일은 지속적으로 업데이트 되고 있으니 자신이 필요한 부분을 사용하면 파이썬 개발에 도움이 될 것 같습니다.

반응형