What is requirements.txt in Python?
In Python, the
requirements.txt file is a text file that lists all of the dependencies that a project needs to run. It is used by pip, the Python package installer, to install the necessary packages for a project.
Dependencies in software development refer to the external components or libraries that a project relies on to function properly. A dependency can be a library, a package, or a module that provides specific functionality that the main project needs to run. When a project has dependencies, it means that it cannot function without these external components. For example, if a Python project depends on the
NumPy library for numerical calculations, the project will not run without the
NumPy library is being installed.
Why do we need requirements.txt in Python?
When working on a project, you may depend on certain libraries or packages to run your code, that is the dependencies. However, when you share your project with others, they may not have the same dependencies or packages installed on their computer. The
requirements.txt file helps to solve this problem by providing a list of dependencies that need to be installed for the project to work. So
requirements.txt contains a list of dependencies of a project.
How to create a requirements.txt file?
To create a requirements.txt file, you can use the following steps:
Open the terminal and navigate to the directory that contains your project.
Run the following command:
pip freeze > requirements.txt
This command will generate a list of the installed packages and their versions and save it to a file named
pip freeze command generates a list of all the installed packages and their versions. The
> operator is used to redirect the output of the
pip freeze command to a file named
requirements.txt. So the output of
pip freeze is saved in a file called
How to use requirements.txt to install packages?
To install the packages listed in the requirements.txt file, you can use the following command:
pip install -r requirements.txt
This command will install all of the packages listed in the requirements.txt file.
Example requirements.txt file:
Here is an example of a requirements.txt file for a project that uses the Django web framework and the Pandas library for data analysis:
In this example, the requirements.txt file lists two packages, Django and Pandas, and their respective versions.
requirements.txt file is an essential part of a Python project that helps ensure that the project runs smoothly and consistently on different computers. By using the
requirements.txt file, you can ensure that your project’s dependencies are easily and consistently installed and managed. For any assistance, feel free to contact.
Did you find this article valuable?
Support shamnad sherief by becoming a sponsor. Any amount is appreciated!