bisos.pipreqsPlus 0.1

Overview

bisos.pipreqs-plus is a thin layer on top of pipreqs that addresses two of pipreqs’ shortcomings when generating requirements.txt for real-world Python projects:

1. Non-``.py`` Python source files. pipreqs walks *.py files only. Many projects contain executable Python source under bin/ with different suffixes (.cs, .pcs, .mcs) or no extension at all. pipreqs-plus transparently makes these files visible to pipreqs by building a scratch directory of .py symlinks. Detection is automatic: any file whose first line matches a Python shebang (#!.*python*) is included. An optional --extraExts list catches files that lack a shebang.

2. Namespace-package submodule imports. When pipreqs encounters from NS.X import ... or import NS.X, it collapses the record down to a single NS. For genuine namespace packages where each NS.X is separately published to PyPI (e.g. bisos.b, bisos.common, bisos.pycs), this loses information the requirements.txt needs. pipreqs-plus scans the sources independently for NS.X-style imports and appends the two-level names to requirements.txt. The bare NS line from pipreqs is preserved.

bisos.pipreqs-plus is intended to be broadly useful — it does not depend on the BISOS platform for its core function. It is distributed as a bisos-pip package because that is the packaging convention its author uses.

Package Documentation At Github

The information below is a subset of the full of documentation for this bisos-pip package. More complete documentation is available at: https://github.com/bisos-pip/capability-cs

Table of Contents TOC

• Overview

• Package Documentation At Github

• Installation

  • Installation With pip

  • Installation With pipx

• Usage

  • Minimal invocation

  • Full invocation

  • Parameters

• How it works

• Source code

Installation

The sources for the bisos.pipreqs-plus pip package are maintained at: https://github.com/bisos-pip/pipreqs-plus.

The bisos.pipreqs-plus pip package is available at PYPI as https://pypi.org/project/bisos.pipreqs-plus.

You can install bisos.pipreqs-plus with pip or pipx.

pip install bisos.pipreqs-plus

pipx install bisos.pipreqs-plus

pipx install pipreqs

Usage

pipreqs-plus.cs -i genRequirements --srcDir=./myPackage

pipreqs-plus.cs -i genRequirements                       \
    --srcDir=./myPackage                                 \
    --binDir=./bin                                       \
    --outFile=./requirements.txt                         \
    --namespaces="['bisos', 'other']"                    \
    --extraExts="['cs', 'pcs', 'mcs']"                   \
    --pipreqsMode=no-pin

--namespaces="['bisos', 'other']"
--extraExts="['cs', 'pcs', 'mcs']"

How it works

Given srcDir and binDir, pipreqs-plus.cs builds a scratch directory of .py symlinks:

• Files under srcDir are exposed as-is (they are already .py).

• Files under binDir/* (top level only) are included if:

  1. Their extension is .py, or

  2. Their extension (without dot) is in extraExts, or

  3. Their first line matches ^#!.*\bpython\d*\b (a Python shebang).

  Included files are symlinked with a .py suffix so pipreqs will scan them.

pipreqs is then invoked against the scratch directory and writes outFile.

For each NS in namespaces, the scratch directory is scanned independently for from NS.X ... and import NS.X ... statements. The captured two-level NS.X names are appended to outFile and the file is sort-uniq’d in place.

The scratch directory is removed on exit.

Source code

Source code is written in COMEEGA (https://github.com/bx-blee/comeega); the primary implementation files are:

• file:./bin/pipreqs-plus.cs — CLI entry point.

• file:./bisos/pipreqsPlus/scanner.py — namespace-import scanner.

• file:./bisos/pipreqsPlus/symlinkTree.py — scratch-tree builder with shebang detection.