Pip requirements.txt generator based on imports in project
Project description
===============================
``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
--debug Print debug information
--savepath <file> Save the list of requirements in the given file
Example
-------
::
$ pipreqs /home/project/location
Looking for imports
Getting latest information about packages from PyPI
Found third-party imports: flask, requests, sqlalchemy, docopt
Successfully saved requirements file in /home/project/location/requirements.txt
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.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.
``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
--debug Print debug information
--savepath <file> Save the list of requirements in the given file
Example
-------
::
$ pipreqs /home/project/location
Looking for imports
Getting latest information about packages from PyPI
Found third-party imports: flask, requests, sqlalchemy, docopt
Successfully saved requirements file in /home/project/location/requirements.txt
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.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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pipreqs-0.2.3.tar.gz
(18.4 kB
view details)
Built Distribution
File details
Details for the file pipreqs-0.2.3.tar.gz
.
File metadata
- Download URL: pipreqs-0.2.3.tar.gz
- Upload date:
- Size: 18.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 25ab192b3b1e05bcbe949df1589b9a6a4266a02989c5660d749c15f78f339cb4 |
|
MD5 | 7b5603d07ac3f88698c2cfb53804814e |
|
BLAKE2b-256 | 4a357936a70e8e00304ea124a066182925f7205e24618590d815fdcf49f4cf8f |
Provenance
File details
Details for the file pipreqs-0.2.3-py2.py3-none-any.whl
.
File metadata
- Download URL: pipreqs-0.2.3-py2.py3-none-any.whl
- Upload date:
- Size: 13.5 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0172c7d2b7e0506f00e751bea82938eb4e7739e3d318e4af490e9b6745431dd4 |
|
MD5 | af632f3641f3460de1b0e3735dec4951 |
|
BLAKE2b-256 | ba9a678d161745b38c4f51ab39bbc4ba6c7192deaa21fe8d14341938f1d41457 |