<commit_before>===============================
pipreqs
===============================

.. 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

Work In Progress

Pip Requirements generator

* Free software: Apache license
* Documentation: https://pipreqs.readthedocs.org.

Features
--------

Why not pip freeze?
--------<commit_msg>add example, usage, installation<commit_after>===============================
``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

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

::

    pip install pipreqs

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
 
 
Why not pip freeze?
--------
{'fraction_non_alphanumeric': 0.2409545804464973, 'fraction_numerical': 0.0, 'mean_word_length': 2.951367781155015, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 9, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2421308', 'n_tokens_mistral': 438, 'n_tokens_neox': 405, 'n_words': 82}