Command line utility to run a command, installing needed python packages if it is not installed
Project description
pypirun
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pypirun-2.0.957876-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d1365f316f0d3609f3db0d52a0566d39c4e2d268302f7665c06435197d2c8992 |
|
MD5 | eeaf5d1f4f90296f167fa9a00ec4ebd0 |
|
BLAKE2b-256 | 144c3b2b001b48720600b7bfc7f829e72a92bdf341cb3f341c886aa8ec39a357 |