Project Specification

**/test **/ceval_output

Python.gitignore

DLL files

pycache/ *.py[cod] *$py.class

C extensions

*.so

Distribution / packaging

.Python build/ develop-eggs/ dist/ downloads/ eggs/ .eggs/ lib/ lib64/ parts/ sdist/ var/ wheels/ wheelhouse/ share/python-wheels/ *.egg-info/ .installed.cfg *.egg MANIFEST *.whl

PyInstaller

Usually these files are written by a python script from a template

before PyInstaller builds the exe, so as to inject date/other infos into it.

*.manifest *.spec

Installer logs

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

Unit test / coverage reports

htmlcov/ .tox/ .nox/ .coverage .coverage.* .cache nosetests.xml coverage.xml *.cover *.py,cover .hypothesis/ .pytest_cache/ cover/

Translations

*.mo *.pot

Django stuff:

*.log local_settings.py db.sqlite3 db.sqlite3-journal

Flask stuff:

instance/ .webassets-cache

Scrapy stuff:

.scrapy

Sphinx documentation

docs/_build/ docs/build/ docs/source/_build/

PyBuilder

.pybuilder/ target/

Jupyter Notebook

.ipynb_checkpoints

IPython

profile_default/ ipython_config.py

pyenv

For a library or package, you might want to ignore these files since the code is

intended to run in multiple environments; otherwise, check them in:

.python-version

pipenv

According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.

However, in case of collaboration, if having platform-specific dependencies or dependencies

having no cross-platform support, pipenv may install dependencies that don't work, or not

install all needed dependencies.

#Pipfile.lock

poetry

Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.

This is especially recommended for binary packages to ensure reproducibility, and is more

commonly ignored for libraries.

https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control

#poetry.lock

pdm

Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.

#pdm.lock

pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it

in version control.

https://pdm.fming.dev/#use-with-ide

.pdm.toml

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

pypackages/

Celery stuff

celerybeat-schedule celerybeat.pid

SageMath parsed files

*.sage.py

Environments

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

Spyder project settings

.spyderproject .spyproject

Rope project settings

.ropeproject

mkdocs documentation

/site

ruff

.ruff_cache/

mypy

.mypy_cache/ .dmypy.json dmypy.json

Pyre type checker

.pyre/

pytype static type analyzer

.pytype/

Cython debug symbols

cython_debug/

PyCharm

JetBrains specific template is maintained in a separate JetBrains.gitignore that can

be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore

and can be added to the global gitignore or merged into this file. For a more nuclear

option (not recommended) you can uncomment the following to ignore the entire idea folder.

.idea/

macOS.gitignore

General

.DS_Store .AppleDouble .LSOverride

Icon must end with two \r

Icon

Thumbnails

._*

Files that might appear in the root of a volume

.DocumentRevisions-V100 .fseventsd .Spotlight-V100 .TemporaryItems .Trashes .VolumeIcon.icns .com.apple.timemachine.donotpresent

.AppleDB .AppleDesktop Network Trash Folder Temporary Items .apdisk

Linux.gitignore

Temporary files which can be created if a process still has a handle open of a deleted file

.fuse_hidden*

KDE directory preferences

.directory

Linux trash folder which might appear on any partition or disk

.Trash-*

.nfs files are created when an open file is removed but is still being accessed

.nfs*

Windows.gitignore

Windows thumbnail cache files

Thumbs.db Thumbs.db:encryptable ehthumbs.db ehthumbs_vista.db

Dump file

*.stackdump

Folder config file

[Dd]esktop.ini

Recycle Bin used on file shares

$RECYCLE.BIN/

Windows Installer files

*.cab *.msi *.msix *.msm *.msp

Windows shortcuts

*.lnk

Archives.gitignore

It's better to unpack these files and commit the raw source because

git has its own built in compression methods.

*.7z *.jar *.rar *.zip *.gz *.gzip *.tgz *.bzip *.bzip2 *.bz2 *.xz *.lzma *.cab *.xar

Packing-only formats

*.iso *.tar

Package management formats

*.dmg *.xpi *.gem *.egg *.deb *.rpm *.msi *.msm *.msp *.txz

Xcode.gitignore

Xcode

gitignore contributors: remember to update Global/Xcode.gitignore, Objective-C.gitignore & Swift.gitignore

User settings

xcuserdata/

Compatibility with Xcode 8 and earlier (ignoring not required starting Xcode 9)

*.xcscmblueprint *.xccheckout

Compatibility with Xcode 3 and earlier (ignoring not required starting Xcode 4)

build/ DerivedData/ *.moved-aside *.pbxuser !default.pbxuser *.mode1v3 !default.mode1v3 *.mode2v3 !default.mode2v3 *.perspectivev3 !default.perspectivev3

Gcc Patch

/*.gcno

JetBrains.gitignore

Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm

Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839

User settings

.idea/*

User-specific stuff

.idea//workspace.xml .idea//tasks.xml .idea//usage.statistics.xml .idea//dictionaries .idea/**/shelf

Generated files

.idea/**/contentModel.xml

Sensitive or high-churn files

.idea//dataSources/ .idea//dataSources.ids .idea//dataSources.local.xml .idea//sqlDataSources.xml .idea//dynamic.xml .idea//uiDesigner.xml .idea/**/dbnavigator.xml