{"author":"Vadim Kravcenko","author_email":"vadim.kravcenko@gmail.com","bugtrack_url":null,"classifiers":["Development Status :: 4 - Beta","Intended Audience :: Developers","License :: OSI Approved :: Apache Software License","Natural Language :: English","Programming Language :: Python :: 3","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9"],"description":"=============================================================================\n``pipreqs`` - Generate requirements.txt file for any project based on imports\n=============================================================================\n\n.. image:: https://img.shields.io/travis/bndr/pipreqs.svg\n :target: https://travis-ci.org/bndr/pipreqs\n\n\n.. image:: https://img.shields.io/pypi/v/pipreqs.svg\n :target: https://pypi.python.org/pypi/pipreqs\n\n\n.. image:: https://codecov.io/gh/bndr/pipreqs/branch/master/graph/badge.svg?token=0rfPfUZEAX\n :target: https://codecov.io/gh/bndr/pipreqs\n\n.. image:: https://img.shields.io/pypi/l/pipreqs.svg\n :target: https://pypi.python.org/pypi/pipreqs\n\n\n\nInstallation\n------------\n\n.. code-block:: sh\n\n pip install pipreqs\n\nObs.: if you don't want support for jupyter notebooks, you can install pipreqs without the dependencies that give support to it. \nTo do so, run:\n\n.. code-block:: sh\n\n pip install --no-deps pipreqs\n pip install yarg==0.1.9 docopt==0.6.2\n\nUsage\n-----\n\n::\n\n Usage:\n pipreqs [options] []\n\n Arguments:\n The path to the directory containing the application files for which a requirements file\n should be generated (defaults to the current working directory)\n\n Options:\n --use-local Use ONLY local package info instead of querying PyPI\n --pypi-server Use custom PyPi server\n --proxy Use Proxy, parameter will be passed to requests library. You can also just set the\n environments parameter in your terminal:\n $ export HTTP_PROXY=\"http://10.10.1.10:3128\"\n $ export HTTPS_PROXY=\"https://10.10.1.10:1080\"\n --debug Print debug information\n --ignore ... Ignore extra directories, each separated by a comma\n --no-follow-links Do not follow symbolic links in the project\n --encoding Use encoding parameter for file open\n --savepath Save the list of requirements in the given file\n --print Output the list of requirements in the standard output\n --force Overwrite existing requirements.txt\n --diff Compare modules in requirements.txt to project imports\n --clean Clean up requirements.txt by removing modules that are not imported in project\n --mode Enables dynamic versioning with , or schemes\n | e.g. Flask~=1.1.2\n | e.g. Flask>=1.1.2\n | e.g. Flask\n --scan-notebooks Look for imports in jupyter notebook files.\n\nExample\n-------\n\n::\n\n $ pipreqs /home/project/location\n Successfully saved requirements file in /home/project/location/requirements.txt\n\nContents of requirements.txt\n\n::\n\n wheel==0.23.0\n Yarg==0.1.9\n docopt==0.6.2\n\nWhy not pip freeze?\n-------------------\n\n- ``pip freeze`` only saves the packages that are installed with ``pip install`` in your environment.\n- ``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``).\n- and sometimes you just need to create ``requirements.txt`` for a new project without installing modules.\n\n.. :changelog:\n\nHistory\n-------\n\n0.4.11 (2020-03-29)\n--------------------\n\n* Implement '--mode' (Jake Teo, Jerome Chan)\n\n0.4.8 (2017-06-30)\n--------------------\n\n* Implement '--clean' and '--diff' (kxrd)\n* Exclude concurrent{,.futures} from stdlib if py2 (kxrd)\n\n0.4.7 (2017-04-20)\n--------------------\n\n* BUG: remove package/version duplicates\n* Style: pep8\n\n0.4.5 (2016-12-13)\n---------------------\n\n* Fixed the --pypi-server option\n\n0.4.4 (2016-07-14)\n---------------------\n\n* Remove Spaces in output\n* Add package to output even without version\n\n0.4.2 (2016-02-10)\n---------------------\n\n* Fix duplicated lines in requirements.txt (Dmitry Pribysh)\n\n0.4.1 (2016-02-05)\n---------------------\n\n* Added ignore option (Nick Rhinehart)\n\n0.4.0 (2016-01-28)\n---------------------\n\n* Walk Abstract Syntax Tree to find imports (Kay Sackey)\n\n0.3.9 (2016-01-20)\n---------------------\n\n* Fix regex for docstring comments (#35)\n\n0.3.8 (2016-01-12)\n---------------------\n\n* Add more package mapping\n* fix(pipreqs/mapping): remove pylab reference to matplotlib\n* Remove comments \"\"\" before going through imports\n* Update proxy documentation\n\n0.3.1 (2015-10-20)\n---------------------\n\n* fixed lint warnings (EJ Lee)\n* add --encoding parameter for open() (EJ Lee)\n* support windows directory separator (EJ Lee)\n\n0.3.0 (2015-09-29)\n---------------------\n\n* Add --proxy option\n* Add --pypi-server option\n\n0.2.9 (2015-09-24)\n---------------------\n\n* Ignore irreverent directory when generating requirement.txt (Lee Wei)\n* Modify logging level of \"Requirement.txt already exists\" to warning (Lee Wei)\n\n0.2.8 (2015-05-11)\n---------------------\n\n* Add --force option as a protection for overwrites\n\n0.2.6 (2015-05-11)\n---------------------\n\n* Fix exception when 'import' is used inside package name #17\n* Add more tests\n\n0.2.5 (2015-05-11)\n---------------------\n\n* Fix exception when 'import' is used in comments #17\n* Fix duplicate entries in requirements.txt\n\n0.2.4 (2015-05-10)\n---------------------\n\n* Refactoring\n* fix \"import as\"\n\n0.2.3 (2015-05-09)\n---------------------\n\n* Fix multiple alias imports on the same line (Tiago Costa)\n* More package mappings\n\n0.2.2 (2015-05-08)\n---------------------\n\n* Add ImportName -> PackageName mapping\n* More tests\n\n0.2.1 (2015-05-08)\n---------------------\n\n* Fix for TypeError for implicit conversion\n\n0.2.0 (2015-05-06)\n---------------------\n\n* Add --use-local option\n* Exclude relative imports. (Dongwon Shin)\n* Use \"latest_release_id\" instead of \"release_ids[-1]\" (Dongwon Shin)\n\n0.1.9 (2015-05-01)\n---------------------\n\n* Output tuning (Harri Berglund)\n* Use str.partition() to simplify the logic (cclaus)\n\n0.1.8 (2015-04-26)\n---------------------\n\n* Fixed problems with local imports (Dongwon Shin)\n* Fixed problems with imports with 'as' (Dongwon Shin)\n* Fix indentation, pep8 Styling. (Michael Borisov)\n* Optimize imports and adding missing import for sys module. (Michael Borisov)\n\n0.1.7 (2015-04-24)\n---------------------\n\n* Add more assertions in tests\n* Add more verbose output\n* Add recursive delete to Makefile clean\n* Update Readme\n\n0.1.6 (2015-04-22)\n---------------------\n\n* py3 print function\n\n0.1.5 (2015-04-22)\n---------------------\n\n* Add Readme, Add Examples\n* Add Stdlib into package\n\n0.1.1 (2015-04-22)\n---------------------\n\n* Fix regex matching for imports\n* Release on Pypi\n\n0.1.0 (2015-04-22)\n---------------------\n\n* First release on Github.\n","description_content_type":"text/x-rst","docs_url":null,"download_url":"","downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://github.com/bndr/pipreqs","keywords":"pip,requirements,imports","license":"Apache-2.0","license_expression":null,"license_files":null,"maintainer":"","maintainer_email":"","name":"pipreqs","package_url":"https://pypi.org/project/pipreqs/","platform":null,"project_url":"https://pypi.org/project/pipreqs/","project_urls":{"Homepage":"https://github.com/bndr/pipreqs","Repository":"https://github.com/bndr/pipreqs"},"provides_extra":null,"release_url":"https://pypi.org/project/pipreqs/0.5.0/","requires_dist":["yarg (==0.1.9)","docopt (==0.6.2)","nbconvert (>=7.11.0,<8.0.0)","ipython (==8.12.3)"],"requires_python":">=3.8.1,<3.13","summary":"Pip requirements.txt generator based on imports in project","version":"0.5.0","yanked":false,"yanked_reason":null}

Dependencies of pipreqs (4).
Dependency	Optional
docopt	false
ipython	false
nbconvert	false
yarg	false

Package search

pipreqs

project_urls

Dependencies

All package metadata

Releases