pipreqs

Install pipreqs using pip to generate requirements.txt files based on the imports used in your project.

If you do not need support for scanning Jupyter Notebook files, you can install a minimal version without the notebook-related dependencies.

# Standard installation
pip install pipreqs

# Minimal installation (without Jupyter Notebook support)
pip install --no-deps pipreqs
pip install yarg==0.1.9 docopt==0.6.2

You can install pipreqs directly from the command line using easy_install.

$ easy_install pipreqs

To contribute to pipreqs, follow these steps to set up your local development environment using Poetry:

1. Fork the repository on GitHub.
2. Clone your fork locally.
3. Install dependencies using Poetry with the dev group.
4. Create a new branch for your changes.

Note: pipreqs uses Poetry for dependency management. You must have Poetry installed in your environment.

$ git clone git@github.com:your_name_here/pipreqs.git
$ cd pipreqs/
$ poetry install --with dev
$ git checkout -b name-of-your-bugfix-or-feature

Before committing your changes, ensure they pass linting and testing. Use poetry run to execute the following commands:

• Linting: Run flake8 on the pipreqs directory and the tests directory.
• Unit Tests: Run the unittest discovery.
• Multi-version Testing: Run tox to test against multiple Python versions. (It is recommended to use pyenv or asdf to manage these Python versions).

To run only a specific subset of tests (e.g., tests.test_pipreqs), use the unittest discovery command.

$ poetry run flake8 pipreqs tests
$ poetry run python -m unittest discover
$ poetry run tox

# To run a subset of tests:
$ poetry run python -m unittest tests.test_pipreqs

When your changes are ready, push your branch to GitHub and submit a pull request. Ensure your PR adheres to these guidelines:

1. Include tests: All new functionality must be accompanied by tests.
2. Update documentation: If adding functionality, include a docstring in the new function and update the feature list in README.rst.
3. Compatibility: Ensure the PR works for all currently supported Python and PyPy versions. Verify that tests pass on the CI (Travis CI) for all supported versions.

To report bugs or propose new features, file an issue at https://github.com/bndr/pipreqs/issues.

When reporting a bug, include:

• Operating system name and version.
• Details about your local setup.
• Detailed steps to reproduce the bug.

When proposing a feature, include:

• A detailed explanation of how it would work.
• A narrow scope to facilitate implementation.

If you use virtualenvwrapper, create a dedicated virtual environment for pipreqs and install it using pip.

$ mkvirtualenv pipreqs
$ pip install pipreqs

You can import the pipreqs module directly into your Python scripts to programmatically interact with its functionality.

import pipreqs

Use the --mode flag to control how versions are written to the requirements.txt file using one of the following schemes:

• <compat>: e.g., Flask~=1.1.2
• <gt>: e.g., Flask>=1.1.2
• <non-pin>: e.g., Flask

When generating requirements, you can control how versions are pinned using the --mode flag. This is useful for creating more flexible dependency files.