Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the gitignore file #2

Closed
wesordonez opened this issue Jan 6, 2025 · 1 comment
Closed

Update the gitignore file #2

wesordonez opened this issue Jan 6, 2025 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@wesordonez
Copy link
Owner

Update the gitignore file based on the following gitignore file (cpandadvisors)

pycache
db.sqlite3
media/
.env
firebase-cred.json
encoded.txt
.venv/
*venv/

Created by https://www.toptal.com/developers/gitignore/api/django,python,visualstudiocode

Edit at https://www.toptal.com/developers/gitignore?templates=django,python,visualstudiocode

Django

*.log
*.pot
*.pyc
pycache/
local_settings.py
db.sqlite3
db.sqlite3-journal
media

If your build process includes running collectstatic, then you probably don't need or want to include staticfiles/

in your Git repository. Update and uncomment the following line accordingly.

*staticfiles/

Django.Python Stack

Byte-compiled / optimized / DLL files

*.py[cod]
*$py.class

C extensions

*.so

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

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

Django stuff:

Flask stuff:

instance/
.webassets-cache

Scrapy stuff:

.scrapy

Sphinx documentation

docs/_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

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/

Python

Byte-compiled / optimized / DLL files

C extensions

Distribution / packaging

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.

Installer logs

Unit test / coverage reports

Translations

Django stuff:

Flask stuff:

Scrapy stuff:

Sphinx documentation

PyBuilder

Jupyter Notebook

IPython

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.

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

pdm

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

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

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

Celery stuff

SageMath parsed files

Environments

Spyder project settings

Rope project settings

mkdocs documentation

mypy

Pyre type checker

pytype static type analyzer

Cython debug symbols

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.

Python Patch

Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration

poetry.toml

ruff

.ruff_cache/

LSP config files

pyrightconfig.json

VisualStudioCode

.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
!.vscode/*.code-snippets

Local History for Visual Studio Code

.history/

Built Visual Studio Code Extensions

*.vsix

VisualStudioCode Patch

Ignore all local history of files

.history
.ionide

Ignore DS_Store files across the board

.DS_Store

End of https://www.toptal.com/developers/gitignore/api/django,python,visualstudiocode

@wesordonez wesordonez added the documentation Improvements or additions to documentation label Jan 6, 2025
@wesordonez
Copy link
Owner Author

add *node_modules/ directory to gitignore

@wesordonez wesordonez self-assigned this Jan 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant