Skip to main content

pypirun

Build Status Codestyle Code Coverage Wheel Version Downloads License

The pypirun command is a utility that allows running a python command line script from a python package, even if it is not installed.

Table of contents

Background

This utility was written to allow CI/CD Pipeline templates to be able to function properly when run in docker containers that did not have the python utility needed already installed.

This allows the templates to continue to work in different docker containers without requiring redundant steps to install the needed python packages.

Install

This package can be installed using the Python pip package manager.

In order to install this package the python environment must have:

  • Python 3.6 or newer
  • pip version 8.1.1 or higher
  • setuptools 40.0.0 or higher
$ pip install pypirun

Usage

usage: pypirun [-h] [--interpreter INTERPRETER] [--debug] [--always_install] package command ...

positional arguments:
  package                    Comma seperated list of packages to install, this list cannot contain spaces
  command                    Command to run

optional arguments:
  -h, --help                 show this help message and exit
  --interpreter INTERPRETER  Python interpreter to use
  --debug                    Enable debug output
  --always_install           Install the command even if it exists in the path
  --upgrade_pip              Upgrade the pip before installing packages
  --upgrade_setuptools       Upgrade setuptools before installing packages

Everything on the command line after the package name is executed in an environment with the package installed and on 
the PATH.  As a result, the package and command must come after the optional arguments.

By default pypirun will run the already installed command from the $PATH in the environment if it is found.  The
--always_install flag will force it to install and run the command.

Examples

Run the serviceping utility from the python serviceping package

The following will run the command serviceping -c 1 yahoo.com from the serviceping package:

$ pypirun serviceping serviceping -c 1 yahoo.com
SERVICEPING yahoo.com:80 (72.30.35.10:80).
from yahoo.com:80 (72.30.35.10:80): time=65.50 ms                                                                                                                                                                                                                 --- yahoo.com ping statistics ---
1 packages transmitted, 1 received, 0.0% package loss, time 73.038ms
rtt min/avg/max/dev = 65.50/65.50/65.50/0.00 ms

Run the screwdrivercd.installdeps module from the screwdrivercd package as a script

$ pypirun -m screwdrivercd screwdrivercd.installdeps
$

Screwdriver V4 pypirun command

The pypirun package publishes a screwdriver v4 shared command called python/pypirun.

This command will set up python if it is not installed and install and run a the pypirun command line utility.

The following will run the command serviceping -c 1 yahoo.com from the serviceping package using the screwdriver sd-cmd:

sd-cmd python/pypirun@latest serviceping serviceping -c 1 yahoo.com

Contribute

Please refer to the contributing.md file for information about how to get involved. We welcome issues, questions, and pull requests. Pull Requests are welcome.

Maintainers

Dwight Hubbard: dhubbard@verizonmedia.com

License

This project is licensed under the terms of the BSD open source license. Please refer to LICENSE for the full terms.

Release files for pypirun 2.0.957876

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pypirun 2.0.957876
File Size Uploaded
pypirun-2.0.957876.tar.gz 9.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pypirun 2.0.957876
File Interpreter ABI Platform
pypirun-2.0.957876-py3-none-any.whl Python 3 none any Details

Total release size: 18.9 kB

Release files / pypirun-2.0.957876.tar.gz

Download URL pypirun-2.0.957876.tar.gz
Size 9.9 kB
Tags Source
SHA-256 checksum
How to use checksums
678e8137938a869eda4b095ac52dd1d3938de2b07e45e0c2946a66a30f80105c
BLAKE2b-256 checksum
How to use checksums
d1642e5487b36304f276000c9a34273683d8379eafbceb52bfd1ec3b3e8be952
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.11.9

Release files / pypirun-2.0.957876-py3-none-any.whl

Download URL pypirun-2.0.957876-py3-none-any.whl
Size 9.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d1365f316f0d3609f3db0d52a0566d39c4e2d268302f7665c06435197d2c8992
BLAKE2b-256 checksum
How to use checksums
144c3b2b001b48720600b7bfc7f829e72a92bdf341cb3f341c886aa8ec39a357
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.11.9
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page