`uv init` Add a .gitignore file?

[jordan-carson]

Question

What is the community's thoughts on adding a basic .gitignore file during uv init? My rationale is given uv init creates a .venv folder, which should never be pushed to a git, it would be helpful to add an ignore file to include the .venv.

Simple ignore file such as

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# Environments
.env
.venv

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


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

# IDE specific files
.idea/
.vscode/
*.swp
*.swo

Platform

No response

Version

0.5.2

[nathanjmcdougall]

It's worth noting that the .venv directory itself contains a .gitignore file which prevents it being pushed to git.

[jordan-carson]

It's worth noting that the .venv directory itself contains a .gitignore file which prevents it being pushed to git.

aye yes it does! the good ole exclude everything *.

[zanieb]

It'd be sensible to add something with .pyc ignores and such. I see it as a low priority though.

[nathanjmcdougall]

As per #12886 I think this is already a feature - in my test uv init creates a .gitignore file with these contents:

# Python-generated files
__pycache__/
*.py[oc]
build/
dist/
wheels/
*.egg-info

# Virtual environments
.venv

[WangYihang]

Please use https://github.com/github/gitignore/blob/main/Python.gitignore.

[konstin]

Note that uv removes the need for some of these entries:

• dist: uv adds a .gitignore to the dist folder it creates.
• build/ and *.egg-info: Unless you are using setuptools, these are not created anymore.
• .venv: uv adds a .gitignore to each venv it creates.

[DipakKhade]

it seems like .gitignore is added in uv init

can close this issue

[charliermarsh]

Personally, I'd say we should use Python.gitignore, since it's already curated and the closest thing I can think of to an "industry standard".

[wabisabia]

On a related note: it may be helpful to avoid creating a .gitignore file in the context of a workspace where one likely already exists.

Introducing a --no-gitignore flag would provide flexibility even beyond the workspace use-case. I could then see --no-gitignore later being inferred for workspaces.