Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bndr/pipreqs
pipreqs - Generate pip requirements.txt file based on imports of any project. Looking for maintainers to move this project forward.
https://github.com/bndr/pipreqs
Last synced: 1 day ago
JSON representation
pipreqs - Generate pip requirements.txt file based on imports of any project. Looking for maintainers to move this project forward.
- Host: GitHub
- URL: https://github.com/bndr/pipreqs
- Owner: bndr
- License: apache-2.0
- Created: 2015-04-22T16:38:14.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-07-06T13:32:00.000Z (5 months ago)
- Last Synced: 2024-09-30T15:48:07.685Z (2 months ago)
- Language: Python
- Homepage:
- Size: 414 KB
- Stars: 6,144
- Watchers: 55
- Forks: 384
- Open Issues: 202
-
Metadata Files:
- Readme: README.rst
- Changelog: HISTORY.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
- Authors: AUTHORS.rst
Awesome Lists containing this project
- my-awesome-starred - pipreqs - pipreqs - Generate pip requirements.txt file based on imports of any project (Python)
- awesome-ccamel - bndr/pipreqs - pipreqs - Generate pip requirements.txt file based on imports of any project. Looking for maintainers to move this project forward. (Python)
- awesome-list - pipreqs - Generate pip requirements.txt file based on imports of any project. (Package Management / For Python)
- best-of-python-dev - GitHub - 63% open · ⏱️ 18.02.2024): (Dependency & Package Managers)
- starred-awesome - pipreqs - pipreqs - Generate pip requirements.txt file based on imports of any project (Python)
- jimsghstars - bndr/pipreqs - pipreqs - Generate pip requirements.txt file based on imports of any project. Looking for maintainers to move this project forward. (Python)
README
=============================================================================
``pipreqs`` - Generate requirements.txt file for any project based on imports
=============================================================================
.. image:: https://img.shields.io/travis/bndr/pipreqs.svg
:target: https://travis-ci.org/bndr/pipreqs
.. image:: https://img.shields.io/pypi/v/pipreqs.svg
:target: https://pypi.python.org/pypi/pipreqs
.. image:: https://codecov.io/gh/bndr/pipreqs/branch/master/graph/badge.svg?token=0rfPfUZEAX
:target: https://codecov.io/gh/bndr/pipreqs
.. image:: https://img.shields.io/pypi/l/pipreqs.svg
:target: https://pypi.python.org/pypi/pipreqs
Installation
------------
.. code-block:: sh
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:
.. code-block:: sh
pip install --no-deps pipreqs
pip install yarg==0.1.9 docopt==0.6.2
Usage
-----
::
Usage:
pipreqs [options] []
Arguments:
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 Use custom PyPi server
--proxy 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 ... Ignore extra directories, each separated by a comma
--no-follow-links Do not follow symbolic links in the project
--encoding Use encoding parameter for file open
--savepath 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 Compare modules in requirements.txt to project imports
--clean Clean up requirements.txt by removing modules that are not imported in project
--mode Enables dynamic versioning with , or schemes
| e.g. Flask~=1.1.2
| e.g. Flask>=1.1.2
| e.g. Flask
--scan-notebooks Look for imports in jupyter notebook files.
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.