How are Pipfile and Pipfile.lock used?

by

The concept behind these files is simple and analogue to other already existing tools, if you have some familiarity with Ruby’s Bundler or Node’s Npm. Pipenv is both a package and virtual environment management tool that uses the Pipfile and Pipfile.lock files to achieve these goals.

Pipenv handles the virtual environment for you (no more activate and deactivate required). Below, some basics to get you started, see more at pipenv website.

Getting Started

Start using pipenv is easy, in your project folder type…

$ pipenv install

… and if it already has a requirements.txt file, it will generate a Pipfile file with the requirements and a virtual environment folder, otherwise, it will generate an empty Pipfile file. If you disliked or changed your mind about something that you have installed, just type…

$ pipenv uninstall <package>

… and you’re good to go. To activate the virtual environment that pipenv already generated, go with…

$ pipenv shell

… and your virtual environment will be activated. To leave the environment…

$ exit

… and you will be back to your original terminal session.

Pipfile

The Pipfile file is intended to specify packages requirements for your Python application or library, both to development and execution. You can install a package by simply using…

$ pipenv install flask

… and it will be added as a dependency for deployment and execution or by using …

$ pipenv install --dev pytest

… and it will be used as a dependency for development time. In both cases, if you need to be more specific about the package version, as stated in the documentation pipenv makes use of the same version specifiers used by pip. The file syntax is pretty straight forward, as follows.

[[source]] # Here goes your package sources (where you are downloading your packages from).
url = "https://pypi.python.org/simple"
verify_ssl = true
name = "pypi"

[packages] # Here goes your package requirements for running the application and its versions (which packages you will use when running the application).
requests = "*"
flask = "*"
pandas = "*"

[dev-packages] # Here goes your package requirements for developing the application and its versions (which packages you will use when developing the application)
pylint = "*"
wheel = "*"

[requires] # Here goes your required Python version.
python_version = "3.6"

Pipfile.lock

The Pipfile.lock is intended to specify, based on the packages present in Pipfile, which specific version of those should be used, avoiding the risks of automatically upgrading packages that depend upon each other and breaking your project dependency tree.

You can lock your currently installed packages using…

$ pipenv lock

… and the tool will lookup your virtual environment folder to generate the lock file for you automatically, based on the currently installed versions. The file syntax is not as obvious as is for Pipfile , so for the sake of conciseness, it will not be displayed here.

More Related Contents:

  1. “pip install unroll”: “python setup.py egg_info” failed with error code 1
  2. Why use pip over easy_install?
  3. How to install python3 version of package via pip on Ubuntu?
  4. Getting “Permission Denied” when running pip as root on my Mac
  5. Why are packages installed rather than just linked to a specific environment?
  6. What’s the difference between dist-packages and site-packages?
  7. Python and pip, list all versions of a package that’s available?
  8. Renaming a virtualenv folder without breaking it
  9. What’s the difference between “pip install” and “python -m pip install”?
  10. Is there a way to list pip dependencies/requirements?
  11. Problems with pip install numpy – RuntimeError: Broken toolchain: cannot link a simple C program
  12. How to add a custom CA Root certificate to the CA Store used by pip in Windows?
  13. pip issue installing almost any library
  14. python pip on Windows – command ‘cl.exe’ failed
  15. What is the meaning of “Failed building wheel for X” in pip install?
  16. pip install: Please check the permissions and owner of that directory
  17. Unable to install Python packages using pip in Ubuntu Linux: InsecurePlatformWarning, SSLError, tlsv1 alert protocol version
  18. How to change default install location for pip
  19. Python Pip broken with sys.stderr.write(f”ERROR: {exc}”)
  20. Illegal instruction (core dumped) after running import tensorflow
  21. How can I install Python’s pip3 on my Mac?
  22. pip: no module named _internal
  23. How to install virtualenv without using sudo?
  24. pip throws TypeError: parse() got an unexpected keyword argument ‘transport_encoding’ when trying to install new packages
  25. Trouble installing TextBlob with pip
  26. Can’t install PIL after Mac OS X 10.9
  27. virtualenv: Specifing which packages to use system-wide vs local [duplicate]
  28. Could not find a version that satisfies the requirement for select requirements
  29. Pip command line “ImportError: No Module Named Typing”
  30. Copy complete virtualenv to another pc

Leave a Comment