.gitignore syntax - how to exclude virtualenv sub-directories?

Question

I have a couple different virtual environments in a project, e.g.

~/project_dir/sub_dirs/venv/...

Adding */venv/* to the .gitignore file does not prevent the virtual environment folders and their contents from being excluded. What is the correct syntax to prevent these virtual environment directories from being added to the git repository?

Mcgrew

Is this question about how to ignore or about how to stop ignoring those directories? – Abernethy

Answer 1

per https://github.com/github/gitignore/blob/master/Python.gitignore

venv/ does the trick for sub-directories.

Mcgrew

Does this one work for any venv directory? Mine named tmp_env and it can't be ignored by this file, I still have to manually ignore it. – Germanic

you have to add tmp_env/ in your .gitignore file. – Verisimilitude

Answer 2

1. Create in your current project's folder ".gitignore" file
2. For example, if you have some folders as "venv" and ".vscode" than you just add their names in ".gitignore" file: venv/ .vscode/

Deracinate

Answer 3

I tried everything to get this ignore to work, until I realized the easiest solution to this problem. Set up my virtual environment in a different directory outside the project!

Pycharm for example asks where you want to set up a virtual environment when you open a project with requirements. I just set it up outside in a different directory.

Wolcott

Answer 4

If in Visual Studio, you can simple click in Team Explore -> right button in folder -> ignore

Require

use this way but on pycharm and I found out that I fill wrong .venv instead /venv/ !! – Chura

Answer 5

Inside the .gitignore folder just add the name of the folder with a slash at the end.

Example: venv/

This will ignore all sub directories in the venv folder.

Stacee

Answer 6

I Had similar problem, But i'm trying to exclude 'vir-2.7/' which is not working. Seems the '.'(dot) was interrupted differently by git, so i have changed the directory name to 'vir_2_7', to fix it.

Sachi

Answer 7

My virtual env was named as -venv. I included venv in .gitignore and it worked

Radiobroadcast