mirror of
https://github.com/bndr/pipreqs.git
synced 2025-06-06 19:45:22 +00:00
add example, usage, installation
This commit is contained in:
parent
68e08af6c5
commit
2ce5bc9ea9
32
README.rst
32
README.rst
@ -1,5 +1,5 @@
|
|||||||
===============================
|
===============================
|
||||||
pipreqs
|
``pipreqs`` - Generate requirements.txt file for any project based on imports
|
||||||
===============================
|
===============================
|
||||||
|
|
||||||
.. image:: https://img.shields.io/travis/bndr/pipreqs.svg
|
.. image:: https://img.shields.io/travis/bndr/pipreqs.svg
|
||||||
@ -8,15 +8,33 @@ pipreqs
|
|||||||
.. image:: https://img.shields.io/pypi/v/pipreqs.svg
|
.. image:: https://img.shields.io/pypi/v/pipreqs.svg
|
||||||
:target: https://pypi.python.org/pypi/pipreqs
|
:target: https://pypi.python.org/pypi/pipreqs
|
||||||
|
|
||||||
Work In Progress
|
Installation
|
||||||
|
------------
|
||||||
|
|
||||||
Pip Requirements generator
|
::
|
||||||
|
|
||||||
* Free software: Apache license
|
pip install pipreqs
|
||||||
* Documentation: https://pipreqs.readthedocs.org.
|
|
||||||
|
Usage
|
||||||
|
-----
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
pipreqs <path> [options]
|
||||||
|
|
||||||
|
Options:
|
||||||
|
--savepath Supply custom path for requirements.txt
|
||||||
|
--debug See debug output
|
||||||
|
|
||||||
|
Example
|
||||||
|
-------
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
$ pipreqs /home/project/location
|
||||||
|
Successfuly saved requirements file in: /home/project/location/requirements.txt
|
||||||
|
|
||||||
Features
|
|
||||||
--------
|
|
||||||
|
|
||||||
Why not pip freeze?
|
Why not pip freeze?
|
||||||
--------
|
--------
|
||||||
|
Loading…
x
Reference in New Issue
Block a user