hostess
provides lightweight, Pythonic interfaces to distributed resources,
system processes, and Python internals. It includes high-level modules that
provide special functionality for working with EC2 instances and S3 buckets,
and a framework (station
) for workflow coordination -- along with all their
lower-level building blocks.
hostess
reduces syntactic headaches and boilerplate while still
allowing low-level manipulation and, more broadly, still feeling like code.
hostess
has a special emphasis on fitting intuitively and idiomatically into
common data science and scientific analysis workflows, but it is fundamentally
a general-purpose utility and administration library.
hostess
is available on PyPI and conda-forge. We recommend installing it
into a Conda environment using conda
:
conda install -n my_environment -c conda-forge hostess
.
The conda-forge package installs all optional dependencies other than those for tests and Notebooks. If you require more granular control over dependencies, please install from source.
Examples for working with EC2 instances can be found in this jupyter notebook.
Examples for working with S3 buckets can be found in this jupyter notebook.
You can find an API reference and full changelog on readthedocs.
hostess
's core features are closely linked to the shell, so it is only fully compatible with Unix-scented operating systems. Linux and MacOS count, as does Windows Subsystem for Linux (WSL). Windows outside of WSL doesn't.- Some
hostess
modules require network access, specificallyssh
and theaws
submodules. Theaws
submodules also require an AWS account. See the example Notebooks for more details on this. hostess
requires Python >= 3.9.hostess
is very lightweight. If a machine has enough resources to run a Python interpreter, it can probably runhostess
.hostess.station
is not fully compatible with MacOS or WSL. MacOS and WSL compatibility is planned. All other parts ofhostess
are compatible with MacOS and WSL.
hostess
is a reliable and fairly feature-complete beta in active use on
multiple projects. However, we do not yet guarantee interface stability or
backwards compatibility.
Also, as with any system administration software, we recommend using it very carefully.
hostess
includes a simple test suite compatible with pytest
. More
comprehensive tests are planned. (In particular, non-local networking features
currently lack test coverage.) You can run the tests by executing pytest -s
in the root directory. The -s
flag is mandatory because pytest
captures
stdout by default, which breaks some hostess
features covered by the tests.
Tests require two additional dependencies: pytest
and pillow
.
You can do almost anything with this software that you like, subject only to the extremely permissive terms of the BSD 3-Clause License.