Reference¶

• Install
• Usage
• Environment

The CLI executable is bpr or brew-python-resources.

The help is available with --help.

usage: bpr [-e EXCLUDE] [-i INCLUDE] [-s] [-v] [-C] [-V] [-D] [-h] [package]  # (1)!

example: bpr [package]

positional arguments:
  package               Package name or file path

options:
  -e, --exclude EXCLUDE
                        Exclude regex patterns [CSV]
  -i, --include INCLUDE
                        Include regex patterns [CSV]
  -s, --single          Process single package
  -v, --verbose         Verbose output [debug: -vvv]
  -C, --clear-cache     Clear request cache
  -V, --version         Show installed version
  -D, --docs            Launch docs in browser
  -h, --help            Show this help message

1. Tip: Save your options with Environment Variables.

To view the source code, see the cli.py on GitHub.

Note: single should not be used with exclude or include.

Install¶

From PyPI , Homebrew or GitHub .

uv tool install brew-python-resources

pip install brew-python-resources

brew install cssnr/tap/brew-python-resources

curl https://i.jpillora.com/cssnr/sharex-cli! | bash  # (1)!

Upgrade.

uv tool upgrade brew-python-resources

pip install -U brew-python-resources

brew update && brew install brew-python-resources

curl https://i.jpillora.com/cssnr/sharex-cli! | bash  # (1)!

Uninstall.

uv tool uninstall brew-python-resources

pip uninstall brew-python-resources

brew uninstall brew-python-resources

rm -f /usr/local/bin/sharex  # (1)!

Run without installing using astral-sh/uv .

uvx brew-python-resources

Check the installed --version.

bpr -V

Usage¶

The Python Version depends on the running interpreter.

python --version

To generate resources for a specific version, use that version.

uv venv --python 3.10
source .venv/bin/activate
python --version

The CLI executable is bpr or brew-python-resources.

Run on a published pacakge.

bpr sharex-cli

Run on a package file.

bpr dist/sharex-cli-0.0.1-py3-none-any.whl

Process a single resource.

bpr sharex-cli -s

Exclude or include packages with regex. Comma seperated list of patterns.

bpr sharex-cli -e "colorama"
bpr sharex-cli -i "click,requests,typer"

Increase output with --verbose. Debug with -vv or -vvv.

bpr sharex-cli -v

Output results to a file.

bpr sharex-cli > output.txt

Run without installing using astral-sh/uv .

uvx brew-python-resources sharex-cli

Example (verbose output).

$ bpr -v toml-run
Package: toml-run
Python 3.8.20 (default, Oct  2 2024, 16:34:12)
--- COPY RESOURCES BELOW HERE -----------------------------------------------------------------------

  resource "tomli" do
    url "https://files.pythonhosted.org/packages/52/ed/3f73f72945444548f33eba9a87fc7a6e969915e7b1acc8260b30e1f76a2f/tomli-2.3.0.tar.gz"
    sha256 "64be704a875d2a59753d80ee8a533c3fe183e3f06807ff7dc2232938ccb01549"
  end

--- COPY RESOURCES ABOVE HERE -----------------------------------------------------------------------

Note: verbose outputs to stderr so you can still capture the resources with stdout.

Environment¶

Many options support setting environment variable defaults.

Allowed boolean values, case-insensitive.

0, f, n, no, off, false
1, t, y, on, yes, true

You can temporarily set variables on the command line.

export BPR_VERBOSE=1

$env:BPR_VERBOSE=1