Django Web Framework Tutorials

gitignore File for Django and Django Rest Framework

Last Updated: by

Django and Django Rest Framework (DRF) are powerful tools for building web applications and RESTful APIs in Python. When working on Django and DRF projects, it’s crucial to manage your codebase efficiently and keep sensitive or unnecessary files out of your Git repository. This is where the .gitignore file comes into play.. In this blog, we will explore importance of .gitignore in Django and DRF projects and provide examples of how to use it effectively.

The .gitignore File

The .gitignore file is a configuraetion file used by Git to specify files and directories that should be excluded from version control. This is particularly useful for keeping your repository clean, avoiding accidental commits of sensitive information, and reducing the repository size.

Here is git ignore file for your Django Projects. This ignore file also work with Visual Studio, Sublime and IntelliJ IDE. Create a file in your with name – .gitignore and paste the bellow code in it.

# Django
*.log
*.pot
*.pyc
__pycache__
db.sqlite3
media

# Backup files
*.bak

# PyCharm
.idea/
*.iws
out/

# Gradle
.idea/gradle.xml
.idea/libraries

# File-based project format
*.iws

# IntelliJ
out/

# JIRA plugin
atlassian-ide-plugin.xml

# Python
*.py[cod]
*$py.class

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
*.egg-info/
.installed.cfg
*.egg
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
.pytest_cache/
nosetests.xml
coverage.xml
*.cover
.hypothesis/

# Jupyter Notebook
.ipynb_checkpoints

# pyenv
.python-version

# celery
celerybeat-schedule.*

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/


# Sublime Text
*.tmlanguage.cache
*.tmPreferences.cache
*.stTheme.cache
*.sublime-workspace
*.sublime-project

# Visual Studio Code
.vscode/
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
.history

Why .gitignore is Essential for Django Projects

Django projects generate various files and directories during development and deployment that shouldn’t be part of your Git repository. Some of the common items you want to exclude include:

  1. Virtual Environment: You don’t want to include your virtual environment and its dependencies, as they can be generated or recreated easily.
  2. Database Files: SQLite database files (e.g.. db.sqlite3) should be ignored since they contain sensitive data and can be regenerated from Django migrations.
  3. Static and Media Files: Files uploaded by users (media files) and static files generated by Django should be ignored as they can be regenerated.
  4. IDE and Text Editor Files: Files generated by your development environment or text editors (e.g., .vscode, .idea, .pyc) should be ignored to prevent conflicts.

Conclusion

A well-configured .gitignore file is essential for maintaining a clean and secure Django and DRF project repository. By specifying which files and directories to exclude from version control, you can prevent accidental commits of sensitive information, reduce repository size, and ensure that your codebase remains focused and manageable.

When working on Django and DRF projects, remember to tailor your .gitignore file to your specific needs, and regularly review it to accommodate any changes in your project structure or dependencies. With an effective .gitignore file, you’ll be well on your way to managing your Django and DRF projects efficiently.