DEV Community

Cover image for TRICK: Easy requirements build
Lucas de Brito Silva
Lucas de Brito Silva

Posted on

TRICK: Easy requirements build

#python #pip #help #productivity

A few days ago I was doing a project in Python and wanted to let it practice for anyone who wanted to access it, and one of the steps for that was to build the requirements.txt, that commonly loads the necessary packages to run the projects in Python and the easiest alternative is:

  • view the packages in the project;
  • select the packages after executing: 
$ pip freeze
Enter fullscreen mode Exit fullscreen mode

But that's not practical at all, so I looked for an alternative that would meet my need, and found a project that did just that. Its goal is generate requirements.txt based on imports in project.

To install this package, just run:

$ pip install pipreqs --user
Enter fullscreen mode Exit fullscreen mode

or, if you use Python3:

$ pip3 install pipreqs --user
Enter fullscreen mode Exit fullscreen mode

To build automatically your requirements.txt, just run the following command in the project directory:

$ pipreqs
Enter fullscreen mode Exit fullscreen mode

or

$ pipreqs /project/location
Enter fullscreen mode Exit fullscreen mode

And the magic will happen!!

Magic
I hope this post helped and feel free to get in touch! ;)
Thanks for reading!

This post is inspired by the following repository:

GitHub logo bndr / pipreqs

pipreqs - Generate pip requirements.txt file based on imports of any project. Looking for maintainers to move this project forward.

pipreqs - Generate requirements.txt file for any project based on imports

image

image

image

image

Installation

pip install pipreqs

Obs.: if you don't want support for jupyter notebooks, you can install pipreqs without the dependencies that give support to it. To do so, run:

pip install --no-deps pipreqs
pip install yarg==0.1.9 docopt==0.6.2

Usage

Usage
    pipreqs [options] [<path>]

Arguments:
    <path>                The path to the directory containing the application files for which a requirements file
                          should be generated (defaults to the current working directory)

Options:
    --use-local           Use ONLY local package info instead of querying PyPI
    --pypi-server <url>   Use custom PyPi server
    --proxy <url>         Use Proxy, parameter will be passed to requests library. You can also just set the
                          environments parameter in your terminal:
                          $ export HTTP_PROXY="http://10.10.1.10:3128"
                          $ export HTTPS_PROXY="https://10.10.1.10:1080"
    --debug               Print debug information
    --ignore <dirs>...    Ignore extra directories, each separated by a comma
    --no-follow-links     Do not follow symbolic links in the project
    --encoding <charset>  Use encoding
…
View on GitHub

Top comments (0)

Read next

codepicker profile image

Java vs Python: Which Should You Choose for Your Career?

CodePicker -

mywillandprobate profile image

Navigating inheritance disputes: Why you need estate planning solicitors in London

My Will And Probate -

hyperkai profile image

Warning Filter in Python

Super Kai (Kazuya Ito) -

makram_eltimani profile image

Creating a Free AI voice-to-text transcription Program using Whisper

Makram El Timani -