gitignore/Python.gitignore

# Byte-compiled / optimized / 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/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# 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/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
.hypothesis/
.pytest_cache/

# Translations
*.mo
*.pot

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

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
target/

# Jupyter Notebook
.ipynb_checkpoints

# pyenv
.python-version

# celery beat schedule file
celerybeat-schedule

# 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

# mypy
.mypy_cache/
.dmypy.json
Comment for .py[cod] files Commenting the only ignore that isn't commented. 2013-04-13 23:46:22 -05:00			`# Byte-compiled / optimized / DLL files`
Make Python .gitignore directory entries match only directories. This commit also alphabetizes the distribution/packaging section after separating the directory entries from the file entries. I left alone a few entries that I'm not sure about (i.e. *.egg and the "Mr Developer" section). 2013-01-16 18:37:11 -08:00			`__pycache__/`
add '.pyd' and '.so' (C extensions) in Python.gitignore 2012-04-12 16:21:38 -03:00			`*.py[cod]`
Add Jython compiled class files to the Python ignore file. 2015-04-28 19:41:00 +01:00			`*$py.class`
add '.pyd' and '.so' (C extensions) in Python.gitignore 2012-04-12 16:21:38 -03:00
			`# C extensions`
			`*.so`
Add package, installer, unit test and coverage files. 2010-11-09 06:11:17 +08:00
Make Python .gitignore directory entries match only directories. This commit also alphabetizes the distribution/packaging section after separating the directory entries from the file entries. I left alone a few entries that I'm not sure about (i.e. *.egg and the "Mr Developer" section). 2013-01-16 18:37:11 -08:00			`# Distribution / packaging`
Update Python.gitignore 2013-12-14 12:07:26 -02:00			`.Python`
Make Python .gitignore directory entries match only directories. This commit also alphabetizes the distribution/packaging section after separating the directory entries from the file entries. I left alone a few entries that I'm not sure about (i.e. *.egg and the "Mr Developer" section). 2013-01-16 18:37:11 -08:00			`build/`
			`develop-eggs/`
			`dist/`
add downloads/ in Distribution / packaging 2014-02-19 20:16:17 +05:30			`downloads/`
Make Python .gitignore directory entries match only directories. This commit also alphabetizes the distribution/packaging section after separating the directory entries from the file entries. I left alone a few entries that I'm not sure about (i.e. *.egg and the "Mr Developer" section). 2013-01-16 18:37:11 -08:00			`eggs/`
add .eggs/ directory to Python.gitignore 2015-02-02 22:46:23 +01:00			`.eggs/`
Make Python .gitignore directory entries match only directories. This commit also alphabetizes the distribution/packaging section after separating the directory entries from the file entries. I left alone a few entries that I'm not sure about (i.e. *.egg and the "Mr Developer" section). 2013-01-16 18:37:11 -08:00			`lib/`
			`lib64/`
			`parts/`
			`sdist/`
			`var/`
Ignore wheels directory. As eggs/ directory, wheels directory may contain compiled wheels. 2016-11-26 20:46:06 -03:00			`wheels/`
Make Python .gitignore directory entries match only directories. This commit also alphabetizes the distribution/packaging section after separating the directory entries from the file entries. I left alone a few entries that I'm not sure about (i.e. *.egg and the "Mr Developer" section). 2013-01-16 18:37:11 -08:00			`*.egg-info/`
Added buildout directories and the configuration data files. 2010-11-10 23:33:30 +01:00			`.installed.cfg`
Make Python .gitignore directory entries match only directories. This commit also alphabetizes the distribution/packaging section after separating the directory entries from the file entries. I left alone a few entries that I'm not sure about (i.e. *.egg and the "Mr Developer" section). 2013-01-16 18:37:11 -08:00			`*.egg`
add MANIFEST to Python.gitignore add MANIFEST which is GENERATED by distutils Reasons for making this change: if you use distutils.core to setup, the file MANIFEST is generated by distutils when run 'python setup.py sdist' 2017-05-26 16:30:51 +08:00			`MANIFEST`
Add package, installer, unit test and coverage files. 2010-11-09 06:11:17 +08:00
PyInstaller .manifest # 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. .exe.manifest .manifest Example template ``` <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <assembly xmlns="urn:schemas-microsoft-com:asm.v1" manifestVersion="1.0"> <assemblyIdentity type="win32" name="SourceCoder" version="14.2.22.0" processorArchitecture="x86" /> <description>Description</description> <trustInfo xmlns="urn:schemas-microsoft-com:asm.v3"> <security> <requestedPrivileges> <requestedExecutionLevel level="asInvoker" uiAccess="false" /> </requestedPrivileges> </security> </trustInfo> <dependency> <dependentAssembly> <assemblyIdentity type="win32" name="Microsoft.Windows.Common-Controls" version="6.0.0.0" processorArchitecture="x86" publicKeyToken="6595b64144ccf1df" language="*" /> </dependentAssembly> </dependency> <dependency> <dependentAssembly> <assemblyIdentity type="win32" name="Microsoft.VC90.CRT" version="9.0.21022.8" processorArchitecture="x86" publicKeyToken="1fc8b3b9a1e18e3b" /> </dependentAssembly> </dependency> </assembly> ``` 2014-02-22 00:22:15 -06:00			`# PyInstaller`
Remove trailing space 2014-08-15 13:16:24 +02:00			`# Usually these files are written by a python script from a template`
PyInstaller .manifest # 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. .exe.manifest .manifest Example template ``` <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <assembly xmlns="urn:schemas-microsoft-com:asm.v1" manifestVersion="1.0"> <assemblyIdentity type="win32" name="SourceCoder" version="14.2.22.0" processorArchitecture="x86" /> <description>Description</description> <trustInfo xmlns="urn:schemas-microsoft-com:asm.v3"> <security> <requestedPrivileges> <requestedExecutionLevel level="asInvoker" uiAccess="false" /> </requestedPrivileges> </security> </trustInfo> <dependency> <dependentAssembly> <assemblyIdentity type="win32" name="Microsoft.Windows.Common-Controls" version="6.0.0.0" processorArchitecture="x86" publicKeyToken="6595b64144ccf1df" language="*" /> </dependentAssembly> </dependency> <dependency> <dependentAssembly> <assemblyIdentity type="win32" name="Microsoft.VC90.CRT" version="9.0.21022.8" processorArchitecture="x86" publicKeyToken="1fc8b3b9a1e18e3b" /> </dependentAssembly> </dependency> </assembly> ``` 2014-02-22 00:22:15 -06:00			`# before PyInstaller builds the exe, so as to inject date/other infos into it.`
			`*.manifest`
.spec files also 2014-02-22 03:48:38 -06:00			`*.spec`
PyInstaller .manifest # 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. .exe.manifest .manifest Example template ``` <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <assembly xmlns="urn:schemas-microsoft-com:asm.v1" manifestVersion="1.0"> <assemblyIdentity type="win32" name="SourceCoder" version="14.2.22.0" processorArchitecture="x86" /> <description>Description</description> <trustInfo xmlns="urn:schemas-microsoft-com:asm.v3"> <security> <requestedPrivileges> <requestedExecutionLevel level="asInvoker" uiAccess="false" /> </requestedPrivileges> </security> </trustInfo> <dependency> <dependentAssembly> <assemblyIdentity type="win32" name="Microsoft.Windows.Common-Controls" version="6.0.0.0" processorArchitecture="x86" publicKeyToken="6595b64144ccf1df" language="*" /> </dependentAssembly> </dependency> <dependency> <dependentAssembly> <assemblyIdentity type="win32" name="Microsoft.VC90.CRT" version="9.0.21022.8" processorArchitecture="x86" publicKeyToken="1fc8b3b9a1e18e3b" /> </dependentAssembly> </dependency> </assembly> ``` 2014-02-22 00:22:15 -06:00
Add package, installer, unit test and coverage files. 2010-11-09 06:11:17 +08:00			`# Installer logs`
			`pip-log.txt`
add ignore "pip-delete-this-directory.txt" 2012-08-23 15:40:36 -03:00			`pip-delete-this-directory.txt`
Add package, installer, unit test and coverage files. 2010-11-09 06:11:17 +08:00
			`# Unit test / coverage reports`
Ignore coverage results coverage.py creates HTML reports in the htmlcov directory (this tool can also be used with coveralls.io) http://nedbatchelder.com/code/coverage/ https://pypi.python.org/pypi/coverage 2014-03-06 10:07:26 +02:00			`htmlcov/`
Make Python .gitignore directory entries match only directories. This commit also alphabetizes the distribution/packaging section after separating the directory entries from the file entries. I left alone a few entries that I'm not sure about (i.e. *.egg and the "Mr Developer" section). 2013-01-16 18:37:11 -08:00			`.tox/`
Add package, installer, unit test and coverage files. 2010-11-09 06:11:17 +08:00			`.coverage`
Add .coverage. to Python.gitignore When using `coverage -p` to get coverage for test runs in several environments coverage creates files on the form .coverage.hostname.timestamp. 2015-02-12 11:17:44 +01:00			`.coverage.*`
Add .cache to the Python .gitignore `.cache` is generated when unittests are run with py.test 2013-08-05 23:17:52 +01:00			`.cache`
Added nosetests.xml to the python unittest ignores. nosetests.xml is created by the 'nose' test runner when you want xml output, for instance for integration with jenkins. 2011-09-09 12:32:11 +02:00			`nosetests.xml`
Python.gitignore add coverage.xml 2013-10-22 18:17:22 +08:00			`coverage.xml`
Fixed typo 2017-05-12 18:08:06 +09:00			`*.cover`
Ignore temp Hypothesis test things https://github.com/DRMacIver/hypothesis https://hypothesis.readthedocs.org 2015-05-11 11:30:50 +03:00			`.hypothesis/`
Add ignore '.pytest_cache' directory in Unit test section 2018-02-04 17:01:22 +09:00			`.pytest_cache/`
Update Python.gitignore with some commonly used patterns for buildout-based projects 2011-04-04 22:14:03 -05:00
added missing whitespaces in comments 2012-08-18 19:55:23 +03:00			`# Translations`
Update Python.gitignore with some commonly used patterns for buildout-based projects 2011-04-04 22:14:13 -05:00			`*.mo`
Group gettext files in the Python template 2014-02-21 10:52:28 +11:00			`*.pot`
Ignore rope files. Rope (https://bitbucket.org/zjes/rope_py3k/overview) is a refactoring tool for Python. It creates temporary files in `.ropeproject` to cache data. These files should be ignored by default. 2013-11-13 14:32:07 +01:00
Fix a copy/paste mistake 2013-11-12 16:57:54 +11:00			`# Django stuff:`
			`*.log`
Add local_settings to Django's ignore 2015-10-02 09:27:59 -03:00			`local_settings.py`
Ignored default sqlite database of Django 2018-02-25 14:57:08 +01:00			`db.sqlite3`
Added Sphinx documentation 2013-11-13 04:13:14 +11:00
Add .webassets-cache to Flask 2016-04-24 17:02:02 -04:00			`# Flask stuff:`
Add Flask instance folder Contains private configuration. Equivalent to Django's local_settings.py. 2016-02-12 07:14:41 -05:00			`instance/`
Add .webassets-cache to Flask 2016-04-24 17:02:02 -04:00			`.webassets-cache`
Add Flask instance folder Contains private configuration. Equivalent to Django's local_settings.py. 2016-02-12 07:14:41 -05:00
Add scrapy stuff to .gitignore 2015-06-05 12:43:20 -03:00			`# Scrapy stuff:`
			`.scrapy`

Added Sphinx documentation 2013-11-13 04:13:14 +11:00			`# Sphinx documentation`
			`docs/_build/`
Ignoring PyBuilder's target directory 2014-06-15 08:49:06 +02:00
			`# PyBuilder`
			`target/`
Update Python.gitignore 2015-12-13 13:40:01 -02:00
Rename 'IPython Notebook' comment to 'Jupyter Notebook' 2016-10-26 12:48:53 -07:00			`# Jupyter Notebook`
Include ipython notebook checkpoints to gitignore 2015-07-28 15:23:02 -05:00			`.ipynb_checkpoints`
merging Python.gitignore for PR #1801 2016-01-27 20:46:49 -02:00
Update Python.gitignore 2015-12-13 13:40:01 -02:00			`# pyenv`
			`.python-version`
merging Python.gitignore for PR #1801 2016-01-27 20:46:49 -02:00
Update Python.gitignore for celery-beat schedule binary file. 2016-02-25 12:27:21 +05:30			`# celery beat schedule file`
			`celerybeat-schedule`
Merge branch 'master' of github.com:github/gitignore into patch-1 Conflicts: Python.gitignore 2016-03-07 11:51:09 +05:30
Update Python.gitignore 2017-02-19 23:52:08 -08:00			`# SageMath parsed files`
[Python Gitignore] Ignore Sage's parsed files Ignore Sage's parsed files (*.sage.py) that are left after running a .Sage program. 2017-02-19 21:43:08 -08:00			`*.sage.py`

Consolidate all environments in one section Some of these names relate to specific tools, others could be used by multiple tools. In particular, virtualenv, the most popular tool for creating Python environments, does not mandate any of these and venv/ or .venv are simply conventional. It is more readable to group all of these together. 2017-05-22 09:24:44 +00:00			`# Environments`
added dotenv to python gitignore 2016-02-28 19:57:21 +03:00			`.env`
Remove / from .venv 2017-02-01 17:50:44 +01:00			`.venv`
Consolidate all environments in one section Some of these names relate to specific tools, others could be used by multiple tools. In particular, virtualenv, the most popular tool for creating Python environments, does not mandate any of these and venv/ or .venv are simply conventional. It is more readable to group all of these together. 2017-05-22 09:24:44 +00:00			`env/`
Python: don't track virtualenv files. 2016-03-10 17:51:16 +07:00			`venv/`
			`ENV/`
Add env.bak, re-arrange 2017-06-21 15:45:53 +00:00			`env.bak/`
			`venv.bak/`
Python: don't track virtualenv files. 2016-03-10 17:51:16 +07:00
No need to push .spyderproject file in a python project 2016-03-06 12:30:45 +01:00			`# Spyder project settings`
			`.spyderproject`
Added .spyproject to ignored paths Looks like Spyder 3.1 uses .spyproject folder to store workspace config 2017-03-21 12:06:48 +11:00			`.spyproject`
Added .ropeproject directory If anyone uses the ROPE refactoring library this is certainly necessary. 2016-04-01 10:45:44 +02:00
			`# Rope project settings`
			`.ropeproject`
Ignore mkdocs site directory [mkdocs](http://www.mkdocs.org/) is rising as an alternative to Sphinx for project's documentation. The default build command puts the generated documentation in a `site` directory at the root of the project which should be ignored. 2017-03-31 09:53:22 +01:00
			`# mkdocs documentation`
Exclude the root site folder only 2017-04-01 08:38:52 +01:00			`/site`
Ignore mypy's cache directory 2017-05-06 13:30:48 -07:00
			`# mypy`
			`.mypy_cache/`
add .dmypy.json to Python.gitignore. MyPy includes a daemon server that creates a file named .dmypy.json to manage socket connection data. 2018-08-18 12:08:55 -05:00			`.dmypy.json`