pipreqs

===============================
``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://img.shields.io/pypi/dm/pipreqs.svg
:target: https://pypi.python.org/pypi/pipreqs

.. 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
:target: https://pypi.python.org/pypi/pipreqs

Installation
------------

::

pip install pipreqs

Usage
-----

::

Usage:
pipreqs [options] <path>

Options:
--use-local Use ONLY local package information instead of querying PyPI
--pypi-server Use custom PyPi server
--proxy Use Proxy, parameter will be passed to requests library
--debug Print debug information
--encoding <charset> Use encoding parameter for file open
--savepath <file> Save the list of requirements in the given file
--force Overwrite existing requirements.txt

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.

History
-------

0.3.1 (2015-10-20)
---------------------

* fixed lint warnings (EJ Lee)
* add --encoding parameter for open() (EJ Lee)
* support windows directory separator (EJ Lee)

0.3.0 (2015-09-29)
---------------------

* Add --proxy option
* Add --pypi-server option

0.2.9 (2015-09-24)
---------------------

* Ignore irreverent directory when generating requirement.txt (Lee Wei)
* Modify logging level of "Requirement.txt already exists" to warning (Lee Wei)

0.2.8 (2015-05-11)
---------------------

* Add --force option as a protection for overwrites

0.2.6 (2015-05-11)
---------------------

* Fix exception when 'import' is used inside package name #17
* Add more tests

0.2.5 (2015-05-11)
---------------------

* Fix exception when 'import' is used in comments #17
* Fix duplicate entries in requirements.txt

0.2.4 (2015-05-10)
---------------------

* Refactoring
* fix "import as"

0.2.3 (2015-05-09)
---------------------

* Fix multiple alias imports on the same line (Tiago Costa)
* More package mappings

0.2.2 (2015-05-08)
---------------------

* Add ImportName -> PackageName mapping
* More tests

0.2.1 (2015-05-08)
---------------------

* Fix for TypeError for implicit conversion

0.2.0 (2015-05-06)
---------------------

* Add --use-local option
* Exclude relative imports. (Dongwon Shin)
* Use "latest_release_id" instead of "release_ids[-1]" (Dongwon Shin)

0.1.9 (2015-05-01)
---------------------

* Output tuning (Harri Berglund)
* Use str.partition() to simplify the logic (cclaus)

0.1.8 (2015-04-26)
---------------------

* Fixed problems with local imports (Dongwon Shin)
* Fixed problems with imports with 'as' (Dongwon Shin)
* Fix indentation, pep8 Styling. (Michael Borisov)
* Optimize imports and adding missing import for sys module. (Michael Borisov)

0.1.7 (2015-04-24)
---------------------

* Add more assertions in tests
* Add more verbose output
* Add recursive delete to Makefile clean
* Update Readme

0.1.6 (2015-04-22)
---------------------

* py3 print function

0.1.5 (2015-04-22)
---------------------

* Add Readme, Add Examples
* Add Stdlib into package

0.1.1 (2015-04-22)
---------------------

* Fix regex matching for imports
* Release on Pypi

0.1.0 (2015-04-22)
---------------------

* First release on Github.

Metadata

Release files for pipreqs 0.3.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pipreqs 0.3.4
File	Size	Uploaded
pipreqs-0.3.4.tar.gz	20.0 kB	Dec 4, 2015	Details

Built distribution (wheel)

Table of built distributions (wheels) for pipreqs 0.3.4
File	Interpreter	ABI	Platform	Reset
pipreqs-0.3.4-py2.py3-none-any.whl 14.0 kB Dec 4, 2015	Python 2, Python 3	none	any	Details

Total release size: 34.1 kB

Release files / pipreqs-0.3.4.tar.gz

Download URL	pipreqs-0.3.4.tar.gz
Size	20.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`858521affe33b31fb64c77aaf2daecebf8aa7c1c40865befab03d92f2637e4ef`
BLAKE2b-256 checksum How to use checksums	`595ffd2baae436935c9f75a747b3875f61a3fc2513c6113c99b3ae56a845defa`
Upload date	Dec 4, 2015
Uploaded using Trusted Publishing? What is trusted publishing?	No

Release files / pipreqs-0.3.4-py2.py3-none-any.whl

Download URL	pipreqs-0.3.4-py2.py3-none-any.whl
Size	14.0 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`c5cfd6aace4052d0cfd351d4c8d2ed80ffdbfee43905f40c25a2d56e6381fdfd`
BLAKE2b-256 checksum How to use checksums	`3c8026e802a35734bcf6a8665b5fe26afa430db3f9106d02128150ae578c176a`
Upload date	Dec 4, 2015
Uploaded using Trusted Publishing? What is trusted publishing?	No