How to Automatically Generate a `requirements.txt` File from Python Source Code?

Creating 'requirements.txt' from Python Source Code

When working with Python projects without a 'requirements.txt' file, manually creating one can be a tedious task. Fortunately, there is a straightforward method to automate this process by utilizing the import sections of your Python source code.

Solution:

To create a 'requirements.txt' file automatically, follow these steps:

1. Install the pipreqs package, which provides a command-line utility for generating requirements from Python code.

<code class="bash">pip install pipreqs</code>

2. Navigate to the directory containing your Python source code.
3. Run the following command:

<code class="bash">pipreqs /path/to/project</code>

This will create a 'requirements.txt' file in the current directory that lists all the required packages for your project.

Benefits of Pipreqs

Pipreqs offers several advantages over using pip freeze for creating 'requirements.txt' files:

• Accuracy: Pipreqs considers only the imports in your project, excluding any packages installed in your environment that are not directly used in the code.
• Efficiency: Pipreqs avoids installing packages before generating the 'requirements.txt' file, saving time and resources.
• Flexibility: Pipreqs can generate a 'requirements.txt' file even if the packages are not installed in your environment.

The above is the detailed content of How to Automatically Generate a `requirements.txt` File from Python Source Code?. For more information, please follow other related articles on the PHP Chinese website!