NOTICE: After using this package for a few years, we realized we'd attempted to do too many things at once with it. It still provides tremendous functionality for a wide variety of use cases, but for particular corner cases, it became apparent that design decisions made early on were hampering forward progress, and we wouldn't recommend doing things the same way today. Certain aspects of its functionality have inspired more focused packages (reverse-argparse, staged-script), and we hope to do the same with more functionality in the future. For the time being, though, don't expect much development and maintenance here. That said, if you use
shell-loggerand are eager to contribute to its longevity, let us know.
The shell-logger Python package allows you to interact with the shell, while
logging various metadata, statistics, and trace information. Any time you're
tempted to write your own wrapper around things like subprocess.Popen() or
subprocess.run(), consider using shell_logger.ShellLogger.log() instead.
If you're familiar with the Unix script command, this is similar in
principle, but with substantially more functionality. If you're familiar with
Python's logging module, the motivation is similar, but this intends
to capture what's happening in the shell rather than in Python itself.
To get up and running with shell-logger, simply:
python3 -m pip install shell-logger-sandialabsOnce the package is installed, you can simply
from shell_logger import ShellLogger
sl = ShellLogger("Title of Log File")
sl.log("Execute my first command in the shell.", "echo 'Hello World'")
sl.finalize()For more detailed usage and API information, please see our documentation.
If you're having trouble with shell-logger, or just want to ask a question,
head on over to our issue board. If a quick search doesn't yield
what you're looking for, feel free to file an issue.
If you're interested in contributing to the development of shell-logger, we'd
love to have your help 😀 Check out our
contributing guidelines for how to get started.
Past contributors include:
See LICENSE.md and COPYRIGHT.md.
Special thanks to the EMPIRE project for investing in the initial development of this tool, and the GMS project for serving as a second user and contributing to its clean-up.