mirror of
https://github.com/bndr/pipreqs.git
synced 2025-06-08 12:35:25 +00:00
b69429b65d
* fixed MySQL + krbV mappings to be reversed * Working on issue #88 * More --clean tests. * Fixed #88 * mapping aws-sam-translator https://pypi.org/project/aws-sam-translator/ https://github.com/awslabs/serverless-application-model * Fixed#133 Sorted `imports` based on `lowercase` package's `name`, similar to `pip freeze`. * Tweak formatting * Add pyAFQ Mapping * Add discord mapping Map discord to discord.py * Add PyFunctional mapping Maps `functional` to `pyfunctional`. Fixes #232. * Upgrade pip before running tests on travis This should ensure that all tests use the same version of pip and this should hopefully fix the pypy build that is using pip 19 * Upgrading pypy to pypy3 Maybe forcing pypy to use python 3 will solve the issue (although it works fine with python 2.7 at the moment) * Remove unecessary pip upgrade step * Mapping for github3 * changes based on discussions w maintainer * remove obsolete '==' Co-authored-by: Hari Sekhon <harisekhon@gmail.com> Co-authored-by: AlexPHorta <alexandre.horta@gmail.com> Co-authored-by: Pat Myron <PatMyron@users.noreply.github.com> Co-authored-by: Abhishek Kumar Singh <toanant@users.noreply.github.com> Co-authored-by: Ben Bodenmiller <bbodenmiller@gmail.com> Co-authored-by: John Kruper <36000@users.noreply.github.com> Co-authored-by: Paweł Kalemba <5924586+pkalemba@users.noreply.github.com> Co-authored-by: SwiftWinds <12981958+SwiftWinds@users.noreply.github.com> Co-authored-by: Alan Barzilay <alan-barzilay@users.noreply.github.com> Co-authored-by: alan-barzilay <alan.barzilay@gmail.com> Co-authored-by: ryan-rozario <ryan.rozario1999@gmail.com> Co-authored-by: Siyang <teo_siyang@imda.gov.sg>
===============================
``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/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 info instead of querying PyPI
--pypi-server <url> Use custom PyPi server
--proxy <url> Use Proxy, parameter will be passed to requests library. You can also just set the
environments 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 <dirs>... Ignore extra directories
--encoding <charset> Use encoding parameter for file open
--savepath <file> 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 <file> Compare modules in requirements.txt to project imports.
--clean <file> Clean up requirements.txt by removing modules that are not imported in project.
--mode <scheme> Enables dynamic versioning with <compat>, <gt> or <non-pin> schemes.
<compat> | e.g. Flask~=1.1.2
<gt> | e.g. Flask>=1.1.2
<no-pin> | e.g. Flask
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.