docs/gitignore
docs/gitignore
1
0
Fork 0
mirror of https://github.com/github/gitignore synced 2024-11-22 19:54:22 +01:00
Code Issues Releases Wiki Activity
811be05b83
gitignore/Python.gitignore

139 lines
2.0 KiB
Plaintext
Raw Normal View History

Comment for .py[cod] files Commenting the only ignore that isn't commented.
2013-04-14 06:46:22 +02: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 03:37:11 +01:00
__pycache__/
add '.pyd' and '.so' (C extensions) in Python.gitignore
2012-04-12 21:21:38 +02:00
*.py[cod]
Add Jython compiled class files to the Python ignore file.
2015-04-28 20:41:00 +02:00
*$py.class
add '.pyd' and '.so' (C extensions) in Python.gitignore
2012-04-12 21:21:38 +02:00
# C extensions
*.so
Add package, installer, unit test and coverage files.
2010-11-08 23:11:17 +01: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 03:37:11 +01:00
# Distribution / packaging
Update Python.gitignore
2013-12-14 15:07:26 +01: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 03:37:11 +01:00
build/
develop-eggs/
dist/
add downloads/ in Distribution / packaging
2014-02-19 15:46:17 +01: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 03:37:11 +01: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-17 03:37:11 +01:00
lib/
lib64/
parts/
sdist/
var/
Ignore wheels directory. As eggs/ directory, wheels directory may contain compiled wheels.
2016-11-27 00:46:06 +01: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-25 20:23:05 +01: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 03:59:44 +01: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 03:37:11 +01: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-17 03:37:11 +01: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 10:30:51 +02:00
MANIFEST
Add package, installer, unit test and coverage files.
2010-11-08 23:11:17 +01: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 07:22:15 +01: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 07:22:15 +01:00
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
.spec files also
2014-02-22 10:48:38 +01: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 07:22:15 +01:00
Add package, installer, unit test and coverage files.
2010-11-08 23:11:17 +01:00
# Installer logs
pip-log.txt
add ignore "pip-delete-this-directory.txt"
2012-08-23 20:40:36 +02:00
pip-delete-this-directory.txt
Add package, installer, unit test and coverage files.
2010-11-08 23:11:17 +01: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 09:07:26 +01: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 03:37:11 +01:00
.tox/
Add .nox directory for the nox testing tool See: https://github.com/theacodes/nox
2018-09-09 22:39:02 +02:00
.nox/
Add package, installer, unit test and coverage files.
2010-11-08 23:11:17 +01: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-06 00:17:52 +02: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 12:17:22 +02:00
coverage.xml
Fixed typo
2017-05-12 11:08:06 +02:00
*.cover
Ignore coverage annotations reports. (#3131)
2019-09-20 17:59:50 +02:00
*.py,cover
Ignore temp Hypothesis test things https://github.com/DRMacIver/hypothesis https://hypothesis.readthedocs.org
2015-05-11 10:30:50 +02:00
.hypothesis/
Add ignore '.pytest_cache' directory in Unit test section
2018-02-04 09:01:22 +01:00
.pytest_cache/
Add `cover/` to Python.gitignore. (#3310)
2020-02-19 19:09:45 +01:00
cover/
Update Python.gitignore with some commonly used patterns for buildout-based projects
2011-04-05 05:14:03 +02:00
added missing whitespaces in comments
2012-08-18 18:55:23 +02:00
# Translations
Update Python.gitignore with some commonly used patterns for buildout-based projects
2011-04-05 05:14:13 +02:00
*.mo
Group gettext files in the Python template
2014-02-21 00:52:28 +01: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 06:57:54 +01:00
# Django stuff:
*.log
Add local_settings to Django's ignore
2015-10-02 14:27:59 +02:00
local_settings.py
Ignored default sqlite database of Django
2018-02-25 14:57:08 +01:00
db.sqlite3
Add db.sqlite3-journal to Python.gitignore (#3063) See also 15e56afe introduced this for Rails.gitignore. Docs on Sqlite temporary files https://www.sqlite.org/tempfiles.html#rollback_journals Thanks @nickittynack (Nick Reynolds)
2019-05-25 18:16:08 +02:00
db.sqlite3-journal
Added Sphinx documentation
2013-11-12 18:13:14 +01:00
Add .webassets-cache to Flask
2016-04-24 23:02:02 +02:00
# Flask stuff:
Add Flask instance folder Contains private configuration. Equivalent to Django's local_settings.py.
2016-02-12 13:14:41 +01:00
instance/
Add .webassets-cache to Flask
2016-04-24 23:02:02 +02:00
.webassets-cache
Add Flask instance folder Contains private configuration. Equivalent to Django's local_settings.py.
2016-02-12 13:14:41 +01:00
Add scrapy stuff to .gitignore
2015-06-05 17:43:20 +02:00
# Scrapy stuff:
.scrapy
Added Sphinx documentation
2013-11-12 18:13:14 +01: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 16:40:01 +01:00
Rename 'IPython Notebook' comment to 'Jupyter Notebook'
2016-10-26 21:48:53 +02:00
# Jupyter Notebook
Include ipython notebook checkpoints to gitignore
2015-07-28 22:23:02 +02:00
.ipynb_checkpoints
merging Python.gitignore for PR #1801
2016-01-27 23:46:49 +01:00
ignore ipython profile
2018-08-22 11:33:41 +02:00
# IPython
fix typo: should be profile_default instead of default_profile
2018-08-26 18:35:37 +02:00
profile_default/
ignore ipython profile
2018-08-22 11:33:41 +02:00
ipython_config.py
Update Python.gitignore
2015-12-13 16:40:01 +01:00
# pyenv
[Python] .python-version should NOT be ignored (#3274)
2020-02-10 02:25:26 +01:00
# 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
merging Python.gitignore for PR #1801
2016-01-27 23:46:49 +01: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 13:12:02 +01: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
Replace non-ASCII character in comment (#3050) The curly apostrophe in the comment is causing AWS EB CLI to fail. https://stackoverflow.com/a/55988700/594211
2019-05-09 13:03:00 +02:00
# having no cross-platform support, pipenv may install dependencies that don't work, or not
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 13:12:02 +01:00
# install all needed dependencies.
#Pipfile.lock
wtf is a pyflow (#3242)
2019-11-18 14:06:05 +01:00
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
Ignore the __pypackages__ folder for pyflow users. (#3205) See https://github.com/David-OConnor/pyflow for details.
2019-11-08 22:15:10 +01:00
__pypackages__/
Added celerybeat.pid (#3229)
2019-11-08 22:06:39 +01:00
# Celery stuff
Update Python.gitignore for celery-beat schedule binary file.
2016-02-25 07:57:21 +01:00
celerybeat-schedule
Added celerybeat.pid (#3229)
2019-11-08 22:06:39 +01:00
celerybeat.pid
Merge branch 'master' of github.com:github/gitignore into patch-1 Conflicts: Python.gitignore
2016-03-07 07:21:09 +01:00
Update Python.gitignore
2017-02-20 08:52:08 +01: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 06:43:08 +01: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 11:24:44 +02:00
# Environments
added dotenv to python gitignore
2016-02-28 17:57:21 +01: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 11:24:44 +02:00
env/
Python: don't track virtualenv files.
2016-03-10 11:51:16 +01:00
venv/
ENV/
Add env.bak, re-arrange
2017-06-21 17:45:53 +02:00
env.bak/
venv.bak/
Python: don't track virtualenv files.
2016-03-10 11:51:16 +01: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 02:06:48 +01: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 10:53:22 +02:00
# mkdocs documentation
Exclude the root site folder only
2017-04-01 09:38:52 +02:00
/site
Ignore mypy's cache directory
2017-05-06 22:30:48 +02: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 19:08:55 +02: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-18 19:21:30 +02: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 15:25:12 +02:00
# Pyre type checker
.pyre/
Ignore .pytype/ directory (#3301) pytype is a static type analyzer for Python code; it generates files of inferred type information, located by default in .pytype/pyi.
2020-02-09 23:23:33 +01:00
# pytype static type analyzer
.pytype/
Ignore Cython debug symbols (#3330) Cython extension modules built with `gdb_debug=True` spit out debug symbols in the `cython_debug` directory at the top level of the project. The files in this directory contain hardcoded paths and are not shareable/meaningful across environments, so I think it makes sense to include them in a default Python .gitignore.
2020-03-11 13:59:33 +01:00
# Cython debug symbols
cython_debug/
Reference in New Issue Copy Permalink