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

Add poetry.toml to Python.gitignore #3853

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

@FaresAhmedb
Copy link

@FaresAhmedb FaresAhmedb commented Oct 8, 2021

Reasons for making this change:

Poetry is a Python dependency management and packaging tool.

poetry.toml is a local configuration file for projects powered by poetry, The settings
commonly added to this file are user-specific settings like 'cache-dir' and
'virtualenvs.path' and shouldn't be committed for everyone .

Even the poetry repository includes it in it's .gitignore file:
https://github.com/python-poetry/poetry/blob/0d7b16f7f6f5bb63a7a507291064dd18f1ff2d93/.gitignore#L40

Links to documentation supporting these rule changes:

The documentation for poetry.toml: https://python-poetry.org/docs/configuration/

Link to application or project’s homepage:

Poetry is a Python dependency management and packaging tool and can be found at:
https://github.com/python-poetry/poetry
https://python-poetry.org/

`poetry.toml` is a local configuration file for projects powered by poetry, The settings
commonly added to this file are user-specific settings like 'cache-dir' and
'virtualenvs.path' and shouldn't be committed for everyone .

Even the poetry repository includes it in it's `.gitignore` file:
https://github.com/python-poetry/poetry/blob/0d7b16f7f6f5bb63a7a507291064dd18f1ff2d93/.gitignore#L40
@bdougie
Copy link
Collaborator

@bdougie bdougie commented Dec 7, 2021

I am curious if you explain the reason for the poetry toml over the lock file or if they related? #3911

Loading

@FaresAhmedb
Copy link
Author

@FaresAhmedb FaresAhmedb commented Dec 7, 2021

Fixed merge conflicts

I am curious if you explain the reason for the poetry toml over the lock file or if they related? #3911

No, poetry.toml and poetry.lock serve two different purposes. The former is for project specific local configurations (docs) and the latter is for dependency locking (e.g. package-lock.json, Cargo.lock).

Loading

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants