Gitignore

1. Byte-compiled / optimized / DLL files

__pycache__/

• .py[cod]
• $py.class

1. C extensions

• .so

1. Distribution / packaging

.Python build/ develop-eggs/ dist/ downloads/ eggs/ .eggs/ lib/ lib64/ parts/ sdist/ var/ wheels/ share/python-wheels/

• .egg-info/

.installed.cfg

• .egg

MANIFEST

1. PyInstaller
2. Usually these files are written by a python script from a template
3. before PyInstaller builds the exe, so as to inject date/other infos into it.

• .manifest
• .spec

1. Installer logs

pip-log.txt pip-delete-this-directory.txt

1. Unit test / coverage reports

htmlcov/ .tox/ .nox/ .coverage .coverage.* .cache nosetests.xml coverage.xml

• .cover
• .py,cover

.hypothesis/ .pytest_cache/ cover/

1. Translations

• .mo
• .pot

1. Django stuff:

• .log

local_settings.py db.sqlite3 db.sqlite3-journal

1. Flask stuff:

instance/ .webassets-cache

1. Scrapy stuff:

.scrapy

1. Sphinx documentation

docs/_build/

1. PyBuilder

.pybuilder/ target/

1. Jupyter Notebook

.ipynb_checkpoints

1. IPython

profile_default/ ipython_config.py

1. pyenv
2. For a library or package, you might want to ignore these files since the code is
3. intended to run in multiple environments; otherwise, check them in:
4. .python-version

1. pipenv
2. According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
3. However, in case of collaboration, if having platform-specific dependencies or dependencies
4. having no cross-platform support, pipenv may install dependencies that don't work, or not
5. install all needed dependencies.
6. Pipfile.lock

1. poetry
2. Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
3. This is especially recommended for binary packages to ensure reproducibility, and is more
4. commonly ignored for libraries.
5. https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
6. poetry.lock

1. pdm
2. Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
3. pdm.lock
4. pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
5. in version control.
6. https://pdm.fming.dev/#use-with-ide

.pdm.toml

1. PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm

__pypackages__/

1. Celery stuff

celerybeat-schedule celerybeat.pid

1. SageMath parsed files

• .sage.py

1. Environments

.env .venv env/ venv/ ENV/ env.bak/ venv.bak/

1. Spyder project settings

.spyderproject .spyproject

1. Rope project settings

.ropeproject

1. mkdocs documentation

/site

1. mypy

.mypy_cache/ .dmypy.json dmypy.json

1. Pyre type checker

.pyre/

1. pytype static type analyzer

.pytype/

1. Cython debug symbols

cython_debug/

1. PyCharm
2. JetBrains specific template is maintained in a separate JetBrains.gitignore that can
3. be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
4. and can be added to the global gitignore or merged into this file. For a more nuclear
5. option (not recommended) you can uncomment the following to ignore the entire idea folder.
6. .idea/