diff --git a/README.rst b/README.rst index 07fee33..3c4a530 100644 --- a/README.rst +++ b/README.rst @@ -4,20 +4,20 @@ .. 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://img.shields.io/coveralls/bndr/pipreqs.svg + +.. image:: https://img.shields.io/coveralls/bndr/pipreqs.svg :target: https://coveralls.io/r/bndr/pipreqs - - -.. image:: https://img.shields.io/pypi/l/pipreqs.svg + + +.. image:: https://img.shields.io/pypi/l/pipreqs.svg :target: https://pypi.python.org/pypi/pipreqs - + Installation ------------ @@ -32,7 +32,11 @@ Usage :: Usage: - pipreqs [options] + 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 @@ -42,14 +46,15 @@ Usage $ 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 + --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. + --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 @@ -68,10 +73,10 @@ 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``). +- ``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. diff --git a/pipreqs/pipreqs.py b/pipreqs/pipreqs.py index 381d8d9..24eeeb7 100644 --- a/pipreqs/pipreqs.py +++ b/pipreqs/pipreqs.py @@ -18,18 +18,18 @@ Options: 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. + --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. + output --force Overwrite existing requirements.txt --diff Compare modules in requirements.txt to project - imports. + imports --clean Clean up requirements.txt by removing modules - that are not imported in project. + that are not imported in project --mode Enables dynamic versioning with , or schemes. | e.g. Flask~=1.1.2