Skip to main content

A lightweight tool to generate requirements.txt by analyzing import statements

Project description

ShowMeReqs

A lightweight command-line tool that generates requirements.txt by analyzing import statements in your Python projects.

Features

  • Intelligent third-party import detection
  • Automatic requirements.txt generation with precise versions
  • Display missing packages in current environment
  • Display import names that differ from PyPI package names for manual review
  • Clean and intuitive CLI interface

Installation

Install via pip:

pip install showmereqs

Usage

Generate requirements.txt for current directory:

showmereqs .

Or specify a project path:

showmereqs path/to/your/project

Examples

  • Normal Output

Normal Output

  • Special Cases Detection

Special Cases

The tool will:

  • Mark packages not found in current environment
  • Highlight import names that differ from their PyPI package names
  • Generate a clean requirements.txt file or a detail one

Why ShowMeReqs?

Traditional approaches like pip freeze capture all environment dependencies, while modern tools like Poetry can be overly complex for simple needs. ShowMeReqs bridges this gap by offering a streamlined solution that identifies only the dependencies your project actually uses.

Additionally, once ShowMeReqs generates the initial requirements.txt, you can easily migrate to modern package management tools for more comprehensive dependency management.

Acknowledgments & License

This project is licensed under the Apache License, Version 2.0 - see the LICENSE file for details.

ShowMeReqs uses package mapping and stdlib data from pipreqs under the Apache 2.0 license. As pipreqs development has slowed, ShowMeReqs aims to provide an actively maintained alternative for the Python community.

Roadmap

Future releases will include:

  • Additional CLI options for customization
  • Support for excluding specific packages or directories
  • Version range specifications
  • Integration with other package management tools

Feel free to open issues for feature requests or bug reports.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

showmereqs-0.1.3.tar.gz (28.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

showmereqs-0.1.3-py3-none-any.whl (27.6 kB view details)

Uploaded Python 3

File details

Details for the file showmereqs-0.1.3.tar.gz.

File metadata

  • Download URL: showmereqs-0.1.3.tar.gz
  • Upload date:
  • Size: 28.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.7

File hashes

Hashes for showmereqs-0.1.3.tar.gz
Algorithm Hash digest
SHA256 63dd32ddc8006e043a00dffe8e4c2eeafc653e9c1cb44ff4d0cee9dcdaad370b
MD5 72ef515d92c24afd69328b0ff6502254
BLAKE2b-256 d9026287a745bb90ab2cf847f4bf8cf5b4223864e942851b5b061a572e7a0558

See more details on using hashes here.

File details

Details for the file showmereqs-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: showmereqs-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 27.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.7

File hashes

Hashes for showmereqs-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 aa07243b4f790ce43dcecaab070474819d7802c25339505442ca6ea79ecbfa51
MD5 280f09a175ebaa08aab21e6d5ba2a632
BLAKE2b-256 ab455486f92ba3acd84ea3d5dcbab56cf26fb0ea29e32df98279171383bdde44

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page