Skip to content

Commit 7079791

Browse files
JarryShawshiftkey
authored andcommitted
Add ignore rules for Pipenv (#2977)
* Add ignore rules for Pipenv Pipenv uses Pipfile.lock to maintain Python package information (metadata, hash, etc.) installed as described in Pipfile. Thus, Pipfile.lock may vary on different operating systems, platforms when collaborating. This PR adds Pipfile.lock into the Python default gitignore. See http://pipenv.org * Update Python.gitignore Not to ignore Pipfile.lock in default, but explain when and why it should be ignored in case of collaboration. (adjusted according to comment in #2977 by @drothmaler ) * Apply suggestions from code review Co-Authored-By: JarryShaw <jarryshaw@icloud.com> * Update Python.gitignore As suggested by @shiftkey , elaborate on the problems that users might see with `Pipfile.lock`.
1 parent 23f7a81 commit 7079791

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

Python.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,13 @@ ipython_config.py
8282
# pyenv
8383
.python-version
8484

85+
# pipenv
86+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
87+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
88+
# having no cross-platform support, pipenv may install dependencies that don’t work, or not
89+
# install all needed dependencies.
90+
#Pipfile.lock
91+
8592
# celery beat schedule file
8693
celerybeat-schedule
8794

0 commit comments

Comments
 (0)