pipreqs - Man Page

Name

pipreqs ā€” pipreqs Documentation

Contents:

Pipreqs - Generate requirements.txt File for Any Project Based on Imports

.SS Installation

pip install pipreqs

Usage

Usage:
    pipreqs [options] <path>

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
    --encoding <charset>  Use encoding parameter for file open
    --savepath <file>     Save the list of requirements in the given file
    --print               Output the list of requirements in the standard output
    --force               Overwrite existing requirements.txt
    --diff <file>         Compare modules in requirements.txt to project imports.
    --clean <file>        Clean up requirements.txt by removing modules that are not imported in project.
    --no-pin              Omit version of output packages.

Example

$ pipreqs /home/project/location
Successfully saved requirements file in /home/project/location/requirements.txt

Contents of requirements.txt

wheel==0.23.0
Yarg==0.1.9
docopt==0.6.2

Why not pip freeze?

  • pip freeze only saves the packages that are installed with pip install in your environment.
  • pip freeze saves all packages in the environment including those that you don't use in your current project. (if you don't have virtualenv)
  • and sometimes you just need to create requirements.txt for a new project without installing modules.

Installation

At the command line:

$ easy_install pipreqs

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv pipreqs
$ pip install pipreqs

Usage

To use pipreqs in a project:

import pipreqs

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/bndr/pipreqs/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "feature" is open to whoever wants to implement it.

Write Documentation

pipreqs could always use more documentation, whether as part of the official pipreqs docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/bndr/pipreqs/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here's how to set up pipreqs for local development.

  1. Fork the pipreqs repo on GitHub.
  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/pipreqs.git
  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv pipreqs
    $ cd pipreqs/
    $ python setup.py develop
  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ flake8 pipreqs tests
    $ python setup.py test
    $ tox

    To get flake8 and tox, just pip install them into your virtualenv.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
    $ git commit -m "Your detailed description of your changes."
    $ git push origin name-of-your-bugfix-or-feature
  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 2.7, 3.4, 3.5, 3.6, and PyPy. Check https://travis-ci.org/bndr/pipreqs/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ python -m unittest tests.test_pipreqs

Credits

Development Lead

  • Vadim Kravcenko <vadim.kravcenko@gmail.com>

Contributors

None yet. Why not be the first?

History

0.4.8 (2017-06-30)

0.4.7 (2017-04-20)

0.4.5 (2016-12-13)

0.4.4 (2016-07-14)

0.4.2 (2016-02-10)

0.4.1 (2016-02-05)

0.4.0 (2016-01-28)

0.3.9 (2016-01-20)

0.3.8 (2016-01-12)

0.3.1 (2015-10-20)

0.3.0 (2015-09-29)

0.2.9 (2015-09-24)

0.2.8 (2015-05-11)

0.2.6 (2015-05-11)

0.2.5 (2015-05-11)

0.2.4 (2015-05-10)

0.2.3 (2015-05-09)

0.2.2 (2015-05-08)

0.2.1 (2015-05-08)

0.2.0 (2015-05-06)

0.1.9 (2015-05-01)

0.1.8 (2015-04-26)

0.1.7 (2015-04-24)

0.1.6 (2015-04-22)

0.1.5 (2015-04-22)

0.1.1 (2015-04-22)

0.1.0 (2015-04-22)

Author

Vadim Kravcenko

Info

Jun 04, 2021 0.4.8