Proxystore

<!-- Release notes generated using configuration in .github/release.yml at v0.5.2 -->

This is (likely) the last patch release of ProxyStore v0.5 and releases some minor bug fixes and enhancements. The next release will be v0.6 and can be tracked using the [milestone](https://github.com/proxystore/proxystore/milestone/3).

Upgrade Steps

$ pip install --upgrade proxystore


What's Changed

Enhancements
* Support two or more Globus endpoints (279) by gpauloski in https://github.com/proxystore/proxystore/pull/334

Bug Fixes
* Fix long endpoint names being clipped (327) by gpauloski in https://github.com/proxystore/proxystore/pull/329
* Explicitly re-export `Store` in `proxystore.store` (331) by gpauloski in https://github.com/proxystore/proxystore/pull/332

Documentation
* Add zenodo badge by gpauloski in https://github.com/proxystore/proxystore/pull/326

**Full Changelog**: https://github.com/proxystore/proxystore/compare/v0.5.1...v0.5.2

<!-- Release notes generated using configuration in .github/release.yml at v0.5.1 -->

This release introduces some enhancements to ProxyStore v0.5. Notably, ProxyStore has new default behavior for dealing with singleton types, a thread race-condition in store registration was fixed, and some new features have been added!

Upgrade Steps


$ pip install --upgrade proxystore


What's Changed
Breaking Changes
* Avoid proxying singleton types (`True`, `False`, `None`) by gpauloski in https://github.com/proxystore/proxystore/pull/315
Enhancements
* Add `store_registration()` context manager by gpauloski in https://github.com/proxystore/proxystore/pull/317
* Add `clear` flag to `Connector` implementations that support it by gpauloski in https://github.com/proxystore/proxystore/pull/320
Bug Fixes
* Adding lock to register store factory by AK2000 in https://github.com/proxystore/proxystore/pull/321
Internal Changes
* Refactor and simplify `Store` unit tests by gpauloski in https://github.com/proxystore/proxystore/pull/318
Documentation
* Add publications/citations to docs by gpauloski in https://github.com/proxystore/proxystore/pull/306
* Fix example syntax error and add mypy notes by gpauloski in https://github.com/proxystore/proxystore/pull/309
* Fix docstrings rendering as raw HTML by gpauloski in https://github.com/proxystore/proxystore/pull/314

New Contributors
* AK2000 made their first contribution in https://github.com/proxystore/proxystore/pull/321

**Full Changelog**: https://github.com/proxystore/proxystore/compare/v0.5.0...v0.5.1

<!-- Release notes generated using configuration in .github/release.yml at v0.5.0 -->

This release introduces some major structural changes to ProxyStore over nearly 200 commits! The full changelog is listed below, but here's a quick overview of the primary change to ProxyStore's architecture.

Rather than providing different `Store` implementations that subclass `proxystore.store.base.Store`, there is now only a single `Store` type that is initialized with a `Connector`. The `Connector` is the interface to the low-level byte storage, while the `Store` provides the high-level ProxyStore interface and features. You can read more about the conceptual model in the [docs](https://docs.proxystore.dev/main/concepts/).

**Before:**
python
from proxystore.store import register_store
from proxystore.store.redis import RedisStore

store = RedisStore('my-store', host='localhost', port=1234)
register_store(store)

**Now:**
python
from proxystore.connectors.redis import RedisConnector
from proxystore.store import register_store
from proxystore.store import Store

store = Store('my-store', RedisConnector('localhost', 1234))
register_store(store)


The [`Connector`](https://docs.proxystore.dev/main/api/connectors/connector/#proxystore.connectors.connector.Connector) type is a [`Protocol`](https://docs.python.org/3/library/typing.html#typing.Protocol) which will enable third-party code to more easily extend the proxy model to other object communication and storage frameworks.

Upgrade Steps

Dependencies needed by specific `Connector` types have been moved to extras install options. The `all` option will install all possible dependencies. Installing ProxyStore without any extra will provide a minimal installation with only a few dependencies.
bash
$ pip install --upgrade proxystore[all]


Endpoint configuration files changed in 285 and 286. We recommend removing your old configurations and creating new ones.
bash
$ proxystore-endpoint stop {endpoint-name}
$ rm -r ~/.local/share/proxystore/{endpoint-name}
$ proxystore-endpoint configure {endpoint-name} ...
$ proxystore-endpoint start {endpoint-name}


What's Changed

Breaking Changes
* Refactor `Store` implementations into separate `Connector`s by gpauloski in https://github.com/proxystore/proxystore/pull/217
* Move some dependencies to extras by gpauloski in https://github.com/proxystore/proxystore/pull/223
* Rename signaling server to relay server by gpauloski in https://github.com/proxystore/proxystore/pull/229
* Better metric tracking for `Store`s by gpauloski in https://github.com/proxystore/proxystore/pull/237
* Enable automatic relay server reconnection by gpauloski in https://github.com/proxystore/proxystore/pull/268
* Change `Store.set()` to `Store.put()` by gpauloski in https://github.com/proxystore/proxystore/pull/283
* Rename `endpoint.{json,log}` to `config.json` and `log.txt` by gpauloski in https://github.com/proxystore/proxystore/pull/285
* Improve endpoint blob storage options by gpauloski in https://github.com/proxystore/proxystore/pull/286
* Refactor distributed in-memory connectors by gpauloski in https://github.com/proxystore/proxystore/pull/293

Enhancements
* Add shortcut cache check in `Store.exists()` by gpauloski in https://github.com/proxystore/proxystore/pull/232
* Record last event time in `TimeStats` by gpauloski in https://github.com/proxystore/proxystore/pull/239
* Support unregistering stores by instance by gpauloski in https://github.com/proxystore/proxystore/pull/244
* Add context manager support to connector implementations by gpauloski in https://github.com/proxystore/proxystore/pull/245
* Add `test` subcommand to `proxystore-endpoint` by gpauloski in https://github.com/proxystore/proxystore/pull/247
* Improve peer connection error handling by gpauloski in https://github.com/proxystore/proxystore/pull/249
* Support "dormant" connectors in `MultiConnector` by gpauloski in https://github.com/proxystore/proxystore/pull/266
* Make address/interface optional for `{Margo,UCX,ZeroMQ}Connector` by ValHayot in https://github.com/proxystore/proxystore/pull/298

Bug Fixes
* Fix `ZeroMQServer` pickle error with multipart messages by gpauloski in https://github.com/proxystore/proxystore/pull/219
* Reuse HTTP connections in endpoint clients by gpauloski in https://github.com/proxystore/proxystore/pull/290

Internal Changes
* Use `click` for command line interfaces by gpauloski in https://github.com/proxystore/proxystore/pull/226
* Improve logging throughout the package by gpauloski in https://github.com/proxystore/proxystore/pull/243
* Change ASGI to Uvicorn from Hypercorn by gpauloski in https://github.com/proxystore/proxystore/pull/284

Documentation
* Improve documentation by gpauloski in https://github.com/proxystore/proxystore/pull/220
* Include API inventories for external packages by gpauloski in https://github.com/proxystore/proxystore/pull/228
* Fix docker command in contributing guide by gpauloski in https://github.com/proxystore/proxystore/pull/257
* Improve README with better description and example by gpauloski in https://github.com/proxystore/proxystore/pull/271
* Documentation improvements for endpoints and figures by gpauloski in https://github.com/proxystore/proxystore/pull/272
* Migrate funcX to Globus Compute by gpauloski in https://github.com/proxystore/proxystore/pull/276
* Use "Attributes" section for NamedTuple/Dataclass docstrings by gpauloski in https://github.com/proxystore/proxystore/pull/282
* Add a Globus Compute guide by gpauloski in https://github.com/proxystore/proxystore/pull/288

Package Changes
* Add `[all]` extras install option by gpauloski in https://github.com/proxystore/proxystore/pull/227

Development Workflows
* Pin UCX and Margo versions in tox by gpauloski in https://github.com/proxystore/proxystore/pull/213
* Add PR branch cache cleanup action by gpauloski in https://github.com/proxystore/proxystore/pull/230
* Adjust PR tags and release template by gpauloski in https://github.com/proxystore/proxystore/pull/291
* Enable PyLint warning/errors by gpauloski in https://github.com/proxystore/proxystore/pull/294

New Contributors
* charliesabino made their first contribution in 293

**Full Changelog**: https://github.com/proxystore/proxystore/compare/v0.4.1...v0.5.0

<!-- Release notes generated using configuration in .github/release.yml at v0.4.1 -->

This release adds some new backends, the `MultiStore` and `ZeroMQStore`, and overhauls the docs which are now hosted at [docs.proxystore.dev](https://docs.proxystore.dev)!

Upgrade Steps

bash
$ pip install --upgrade proxystore


What's Changed

New Features
* Support Globus consents by gpauloski in https://github.com/proxystore/proxystore/pull/180
* Add `MultiStore` by gpauloski in https://github.com/proxystore/proxystore/pull/193
* Add `ZeroMQStore` by gpauloski in https://github.com/proxystore/proxystore/pull/208

Bug Fixes
* Fix peer-channels not passed to configure by gpauloski in https://github.com/proxystore/proxystore/pull/189
* Use IP instead of hostname for client endpoint requests by gpauloski in https://github.com/proxystore/proxystore/pull/191
* Prevent race condition when iterating over `Store._stats` by WardLT in https://github.com/proxystore/proxystore/pull/207

Documentation
* Migrate to MKDocs by gpauloski in https://github.com/proxystore/proxystore/pull/197

Dependencies
* Support Python 3.11 by gpauloski in https://github.com/proxystore/proxystore/pull/138
* Migrate to `pyproject.toml` by gpauloski in https://github.com/proxystore/proxystore/pull/176
* Bump actions/checkout from 2 to 3 by dependabot in https://github.com/proxystore/proxystore/pull/177
* Upgrade cryptography per CVE-2023-23931 by gpauloski in https://github.com/proxystore/proxystore/pull/190

New Contributors
* dependabot made their first contribution in https://github.com/proxystore/proxystore/pull/177

**Full Changelog**: https://github.com/proxystore/proxystore/compare/v0.4.0...v0.4.1

Development pre-release for the upcoming 0.4.1 version.

What's Changed

Breaking Changes
- Object keys can no longer be specified (PR 90).
- [Store](https://proxystore.readthedocs.io/en/latest/_autosummary/proxystore.store.base.html#proxystore.store.base.Store) keys are now named tuples (PR [91](https://github.com/proxystore/proxystore/pull/91)).
- Move `resolve_async` to [`proxystore.store.utils.resolve_async()`](https://proxystore.readthedocs.io/en/latest/_autosummary/proxystore.store.utils.html#proxystore.store.utils.resolve_async) (PR [103](https://github.com/proxystore/proxystore/pull/103)).
- Remove `init_store()` (PR [157](https://github.com/proxystore/proxystore/pull/157)).
- Support custom serializers (PR [174](https://github.com/proxystore/proxystore/pull/174)).

New Features
- ProxyStore Endpoints for peer-to-peer data transfer via WebRTC. Endpoints can be enabled using the `endpoint` extras install. E.g., `pip install proxystore[endpoint]`. See the [Guide](https://proxystore.readthedocs.io/en/latest/guides/endpoints.html) for more details (PRs [#51](https://github.com/proxystore/proxystore/pull/51), [#53](https://github.com/proxystore/proxystore/pull/53), [#106](https://github.com/proxystore/proxystore/pull/106), [#112](https://github.com/proxystore/proxystore/pull/112), [#129](https://github.com/proxystore/proxystore/pull/129), [#130](https://github.com/proxystore/proxystore/pull/130), [#131](https://github.com/proxystore/proxystore/pull/131), [#137](https://github.com/proxystore/proxystore/pull/137), and [#140](https://github.com/proxystore/proxystore/pull/140)).
- Add built-in Globus auth tools (PR [89](https://github.com/proxystore/proxystore/pull/89)).
- [`Store`](https://proxystore.readthedocs.io/en/latest/_autosummary/proxystore.store.base.html#proxystore.store.base.Store) can now be used as a context manager (PR [93](https://github.com/proxystore/proxystore/pull/93)).
- Add [`ProxyLocker`](https://proxystore.readthedocs.io/en/latest/_autosummary/proxystore.proxy.html#proxystore.proxy.ProxyLocker) and [`locked_proxy()`](https://proxystore.readthedocs.io/en/latest/_autosummary/proxystore.store.base.html#proxystore.store.base.Store.locked_proxy) (PR [108](https://github.com/proxystore/proxystore/pull/108)).
- Store object size in [`TimeStats`](https://proxystore.readthedocs.io/en/latest/_autosummary/proxystore.store.stats.html#proxystore.store.stats.TimeStats) (PR [135](https://github.com/proxystore/proxystore/pull/135)).
- Experimental support for distributed in-memory stores using three backends: websockets, margo, and UCX (PRs [144](https://github.com/proxystore/proxystore/pull/144) and [#163](https://github.com/proxystore/proxystore/pull/163)).
- Support `$PROXYSTORE_HOME` and `$XDG_DATA_HOME` for ProxyStore user data (PR [171](https://github.com/proxystore/proxystore/pull/171)).

Bug Fixes
- Improved typing on [`proxy()`](https://proxystore.readthedocs.io/en/latest/_autosummary/proxystore.store.base.html#proxystore.store.base.Store.proxy) (PR [82](https://github.com/proxystore/proxystore/pull/82)).
- Fix relative path bug in [`FileStore`](https://proxystore.readthedocs.io/en/latest/_autosummary/proxystore.store.file.html#proxystore.store.file.FileStore) (PR [100](https://github.com/proxystore/proxystore/pull/100)).

Non-package Changes
- Dockerfile and images for testing ProxyStore are now located at https://github.com/proxystore/images.
- API docs now use autosummary (PR [132](https://github.com/proxystore/proxystore/pull/132)).
- Major refactor to the test suite (PR [154](https://github.com/proxystore/proxystore/pull/154)).
- GitHub workflow improvements (PRs [155](https://github.com/proxystore/proxystore/pull/155) and [#156](https://github.com/proxystore/proxystore/pull/156)).

New Contributors
* ValHayot made their first contribution in https://github.com/proxystore/proxystore/pull/144

**Full Changelog**: https://github.com/proxystore/proxystore/compare/v0.3.3...v0.4.0