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/
pip-wheel-metadata/
share/python-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/
.nox/
.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

# IPython
profile_default/
ipython_config.py

# pyenv
.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

# 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
dmypy.json

# Pyre type checker
.pyre/
-												Comment for .py[cod] files

Commenting the only ignore that isn't commented.
											
										
										
											2013-04-14 12:46:22 +08: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-17 10:37:11 +08:00
+								__pycache__/
-												add '.pyd' and '.so' (C extensions) in Python.gitignore
											
										
										
											2012-04-13 03:21:38 +08:00
+								*.py[cod]
-												Add Jython compiled class files to the Python ignore file.

											
										
										
											2015-04-29 02:41:00 +08:00
+								*$py.class
-												add '.pyd' and '.so' (C extensions) in Python.gitignore
											
										
										
											2012-04-13 03:21:38 +08: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-17 10:37:11 +08:00
+								# Distribution / packaging
-												Update Python.gitignore
											
										
										
											2013-12-14 22:07:26 +08: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-17 10:37:11 +08:00
+								build/
 								develop-eggs/
 								dist/
-												add downloads/ in Distribution / packaging
											
										
										
											2014-02-19 22:46:17 +08:00
+								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-17 10:37:11 +08:00
+								eggs/
-												add .eggs/ directory to Python.gitignore

											
										
										
											2015-02-03 05:46:23 +08: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-17 10:37:11 +08:00
+								lib/
 								lib64/
 								parts/
 								sdist/
 								var/
-												Ignore wheels directory.

As eggs/ directory, wheels directory may contain compiled wheels.

											
										
										
											2016-11-27 07:46:06 +08:00
+								wheels/
-												Add pip-wheel-metadata to Python.gitignore

PEP-517 has resulted in some updates to the Python
build process. As a result, a new directory called
pip-wheel-metadata is created on fresh builds.
This PR adds this directory into the Python default
gitignore. See
https://github.com/pypa/pip/blob/e5f4bbb7ddff87f48f2b5815513e4211ccdde83a/src/pip/_internal/req/req_install.py#L568

											
										
										
											2019-01-26 03:23:05 +08:00
+								pip-wheel-metadata/
-												Hide wheels directory used on Debian-like systems (Ubuntu)

See https://www.debian.org/doc/packaging-manuals/python-policy/ch-module_packages.html

tl;dr Debian Policy requires wheels to be installed here and thus issuing
python3 -m venv .
on a Debian-like system creates this directory

											
										
										
											2018-11-10 10:59:44 +08:00
+								share/python-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-17 10:37:11 +08:00
+								*.egg-info/
-												Added buildout directories and the configuration data files.

											
										
										
											2010-11-11 06:33:30 +08: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-17 10: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 14:22:15 +08:00
+								# PyInstaller
-												Remove trailing space

											
										
										
											2014-08-15 19:16:24 +08: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 14:22:15 +08:00
+								#  before PyInstaller builds the exe, so as to inject date/other infos into it.
 								*.manifest
-												.spec files also

											
										
										
											2014-02-22 17:48:38 +08: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 14:22:15 +08: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-24 02:40:36 +08: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 16:07:26 +08: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-17 10:37:11 +08:00
+								.tox/
-												Add .nox directory for the nox testing tool

See: https://github.com/theacodes/nox
											
										
										
											2018-09-10 04:39:02 +08:00
+								.nox/
-												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 18:17:44 +08:00
+								.coverage.*
-												Add .cache to the Python .gitignore

`.cache` is generated when unittests are run with py.test
											
										
										
											2013-08-06 06:17:52 +08: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 18:32:11 +08:00
+								nosetests.xml
-												Python.gitignore add coverage.xml
											
										
										
											2013-10-22 18:17:22 +08:00
+								coverage.xml
-												Fixed typo

											
										
										
											2017-05-12 17:08:06 +08:00
+								*.cover
-												Ignore temp Hypothesis test things

https://github.com/DRMacIver/hypothesis
https://hypothesis.readthedocs.org
											
										
										
											2015-05-11 16:30:50 +08:00
+								.hypothesis/
-												Add ignore '.pytest_cache' directory in Unit test section

											
										
										
											2018-02-04 16:01:22 +08:00
+								.pytest_cache/
-												Update Python.gitignore with some commonly used patterns for buildout-based projects

											
										
										
											2011-04-05 11:14:03 +08:00
-												added missing whitespaces in comments
											
										
										
											2012-08-19 00:55:23 +08:00
+								# Translations
-												Update Python.gitignore with some commonly used patterns for buildout-based projects

											
										
										
											2011-04-05 11:14:13 +08:00
+								*.mo
-												Group gettext files in the Python template

											
										
										
											2014-02-21 07:52:28 +08: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 21:32:07 +08:00
-												Fix a copy/paste mistake

											
										
										
											2013-11-12 13:57:54 +08:00
+								# Django stuff:
 								*.log
-												Add local_settings to Django's ignore

											
										
										
											2015-10-02 20:27:59 +08:00
+								local_settings.py
-												Ignored default sqlite database of Django

											
										
										
											2018-02-25 21:57:08 +08:00
+								db.sqlite3
-												Added Sphinx documentation

											
										
										
											2013-11-13 01:13:14 +08:00
-												Add .webassets-cache to Flask
											
										
										
											2016-04-25 05:02:02 +08:00
+								# Flask stuff:
-												Add Flask instance folder

Contains private configuration. Equivalent to Django's local_settings.py.
											
										
										
											2016-02-12 20:14:41 +08:00
+								instance/
-												Add .webassets-cache to Flask
											
										
										
											2016-04-25 05:02:02 +08:00
+								.webassets-cache
-												Add Flask instance folder

Contains private configuration. Equivalent to Django's local_settings.py.
											
										
										
											2016-02-12 20:14:41 +08:00
-												Add scrapy stuff to .gitignore
											
										
										
											2015-06-05 23:43:20 +08:00
+								# Scrapy stuff:
 								.scrapy
-												Added Sphinx documentation

											
										
										
											2013-11-13 01:13:14 +08:00
+								# Sphinx documentation
 								docs/_build/
-												Ignoring PyBuilder's target directory
											
										
										
											2014-06-15 14:49:06 +08:00
 								# PyBuilder
 								target/
-												Update Python.gitignore
											
										
										
											2015-12-13 23:40:01 +08:00
-												Rename 'IPython Notebook' comment to 'Jupyter Notebook'

											
										
										
											2016-10-27 03:48:53 +08:00
+								# Jupyter Notebook
-												Include ipython notebook checkpoints to gitignore

											
										
										
											2015-07-29 04:23:02 +08:00
+								.ipynb_checkpoints
-												merging Python.gitignore for PR #1801

											
										
										
											2016-01-28 06:46:49 +08:00
-												ignore ipython profile

											
										
										
											2018-08-22 17:33:41 +08:00
+								# IPython
-												fix typo: should be profile_default instead of default_profile

											
										
										
											2018-08-27 00:35:37 +08:00
+								profile_default/
-												ignore ipython profile

											
										
										
											2018-08-22 17:33:41 +08:00
+								ipython_config.py
-												Update Python.gitignore
											
										
										
											2015-12-13 23:40:01 +08:00
+								# pyenv
 								.python-version
-												merging Python.gitignore for PR #1801

											
										
										
											2016-01-28 06:46:49 +08:00
-												Add ignore rules for Pipenv (#2977)

* Add ignore rules for Pipenv

Pipenv uses Pipfile.lock to maintain Python package information
(metadata, hash, etc.) installed as described in Pipfile. Thus,
Pipfile.lock may vary on different operating systems, platforms
when collaborating. This PR adds Pipfile.lock into the Python
default gitignore. See http://pipenv.org

* Update Python.gitignore

Not to ignore Pipfile.lock in default, but explain
when and why it should be ignored in case of
collaboration. (adjusted according to comment
in github/gitignore#2977 by @drothmaler )

* Apply suggestions from code review

Co-Authored-By: JarryShaw <jarryshaw@icloud.com>

* Update Python.gitignore

As suggested by @shiftkey , elaborate on the problems that users might see with `Pipfile.lock`.

											
										
										
											2019-03-11 20:12:02 +08:00
+								# 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
-												Update Python.gitignore for celery-beat schedule binary file.
											
										
										
											2016-02-25 14:57:21 +08:00
+								# celery beat schedule file
 								celerybeat-schedule
-												Merge branch 'master' of github.com:github/gitignore into patch-1

Conflicts:
	Python.gitignore

											
										
										
											2016-03-07 14:21:09 +08:00
-												Update Python.gitignore
											
										
										
											2017-02-20 15: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-20 13: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 17:24:44 +08:00
+								# Environments
-												added dotenv to python gitignore
											
										
										
											2016-02-29 00:57:21 +08:00
+								.env
-												Remove / from .venv
											
										
										
											2017-02-02 00:50:44 +08: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 17:24:44 +08:00
+								env/
-												Python: don't track virtualenv files.

											
										
										
											2016-03-10 18:51:16 +08:00
+								venv/
 								ENV/
-												Add env.bak, re-arrange
											
										
										
											2017-06-21 23:45:53 +08:00
+								env.bak/
 								venv.bak/
-												Python: don't track virtualenv files.

											
										
										
											2016-03-10 18:51:16 +08:00
-												No need to push .spyderproject file in a python project

											
										
										
											2016-03-06 19:30:45 +08: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 09:06:48 +08:00
+								.spyproject
-												Added .ropeproject directory

If anyone uses the ROPE refactoring library this is certainly necessary.
											
										
										
											2016-04-01 16:45:44 +08: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 16:53:22 +08:00
 								# mkdocs documentation
-												Exclude the root site folder only
											
										
										
											2017-04-01 15:38:52 +08:00
+								/site
-												Ignore mypy's cache directory
											
										
										
											2017-05-07 04:30:48 +08: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-19 01:08:55 +08:00
+								.dmypy.json
-												add dmypy.json - without initial '.', to Python.gitignore.

Older versions of dmypy used 'dmypy.json' without the initial '.'.
This should be added to Python.gitignore for those using older versions
of MyPy.

											
										
										
											2018-08-19 01:21:30 +08:00
+								dmypy.json
-												Add .pyre directory for Pyre type checker

Pyre is a new type-checker for Python developed by facebook in May 2018.
https://pyre-check.org/

It makes .pyre directory for storing result or cache for type checking.
This directory is environment dependent. So it should be ignored from Git.

											
										
										
											2018-10-23 21:25:12 +08:00
 								# Pyre type checker
 								.pyre/