Skip to content

ProxyStore Extensions

PyPI - Version PyPI - Python Version GitHub License

docs tests pre-commit.ci status

Extensions for the ProxyStore package.

This extensions package contains experimental features, features with non-Python dependencies, and plugins for third-party tools.

Installation

The extensions package can be installed alongside ProxyStore.

$ pip install proxystore[extensions]

Alternatively, the package can be installed directly.

$ pip install proxystore-ex

See the Installation guide for more information about features which require extra dependencies. See the Contributing guide to get started with local development.

Documentation

ProxyStore's documentation is available at docs.proxystore.dev and supplemental documentation for the extensions package is available at extensions.proxystore.dev.

Usage

Features in the proxystore_ex package can be imported from within proxystore via the proxystore.ex module. This is the recommended method for import extension features. E.g.,

from proxystore_ex.connectors.daos import DAOSConnector  # Direct
from proxystore.ex.connectors.daos import DAOSConnector  # Recommended

Citation

The preferred citations for this code are provided at https://docs.proxystore.dev/latest/publications/.