Skip to main content

utilities for filesystem exploration and automated builds

Project description

About Pox

pox provides a collection of utilities for navigating and manipulating filesystems. This module is designed to facilitate some of the low level operating system interactions that are useful when exploring a filesystem on a remote host, where queries such as “what is the root of the filesystem?”, “what is the user’s name?”, and “what login shell is preferred?” become essential in allowing a remote user to function as if they were logged in locally. While pox is in the same vein of both the os and shutil builtin modules, the majority of its functionality is unique and compliments these two modules.

pox provides python equivalents of several unix shell commands such as which and find. These commands allow automated discovery of what has been installed on an operating system, and where the essential tools are located. This capability is useful not only for exploring remote hosts, but also locally as a helper utility for automated build and installation.

Several high-level operations on files and filesystems are also provided. Examples of which are: finding the location of an installed python package, determining if and where the source code resides on the filesystem, and determining what version the installed package is.

pox also provides utilities to enable the abstraction of commands sent to a remote filesystem. In conjunction with a registry of environment variables and installed utilites, pox enables the user to interact with a remote filesystem as if they were logged in locally.

pox is part of pathos, a python framework for heterogeneous computing. pox is in active development, so any user feedback, bug reports, comments, or suggestions are highly appreciated. A list of issues is located at, with a legacy list maintained at

Major Features

pox provides utilities for discovering the user’s environment:

  • return the user’s name, current shell, and path to user’s home directory
  • strip duplicate entries from the user’s $PATH
  • lookup and expand environment variables from ${VAR} to value

pox also provides utilities for filesystem exploration and manipulation:

  • discover the path to a file, exectuable, directory, or symbolic link
  • discover the path to an installed package
  • parse operating system commands for remote shell invocation
  • convert text files to platform-specific formatting

Current Release

This documentation is for version pox-0.3.0.

The latest released version of pox is available from:

pox is distributed under a 3-clause BSD license.

>>> import pox
>>> pox.license()

Development Version

You can get the latest development version with all the shiny new features at:

If you have a new contribution, please submit a pull request.


pox is packaged to install from source, so you can download the tarball, unzip, and run the installer:

$ tar -xvzf pox-0.3.0.tar.gz
$ cd pox-0.3.0
$ python setup py build
$ python setup py install

You will be warned of any missing dependencies and/or settings after you run the “build” step above.

Alternately, pox can be installed with pip or easy_install:

$ pip install pox


pox requires:

  • python, version == 2.7 or version >= 3.6, or pypy

Optional requirements:

  • setuptools, version >= 0.6

More Information

Probably the best way to get started is to look at the documentation at Also see pox.tests for a set of scripts that demonstrate how pox can be used to interact with the operating system. You can run the test suite with python -m pox.tests. All pox utilities can be launched directly from an operating system terminal, using the pox script (or with python -m pox). The source code is also generally well documented, so further questions may be resolved by inspecting the code itself. Please feel free to submit a ticket on github, or ask a question on stackoverflow (@Mike McKerns). If you would like to share how you use pox in your work, please send an email (to mmckerns at uqfoundation dot org).


If you use pox to do research that leads to publication, we ask that you acknowledge use of pox by citing the following in your publication:

M.M. McKerns, L. Strand, T. Sullivan, A. Fang, M.A.G. Aivazis,
"Building a framework for predictive science", Proceedings of
the 10th Python in Science Conference, 2011;

Michael McKerns and Michael Aivazis,
"pathos: a framework for heterogeneous computing", 2010- ;

Please see or for further information.

Project details

Download files

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

Files for pox, version 0.3.0
Filename, size File type Python version Upload date Hashes
Filename, size pox-0.3.0-py2.py3-none-any.whl (30.5 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size (129.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page