How to install sharedbox¶

sharedbox comes as ready-built packages (wheels) on PyPI, so you can install it without a compiler.

Before you start¶

Add it to your project¶

In a project that uv manages:

uv add sharedbox

With pip, inside a virtual environment:

pip install sharedbox

Which wheel you get¶

You don't have to choose a wheel yourself: each platform has three, and the installer picks the one that matches your Python.

They are built for Windows x64 and for Linux x86_64, both for the common glibc-based distributions and for musl-based ones such as Alpine. How the module is built explains why there are three.

Add the benchmark command¶

If you want to measure sharedbox on your own machine, install the benchmarks extra, which adds the benchbox command:

uv add "sharedbox[benchmarks]"

or, with pip:

pip install "sharedbox[benchmarks]"

How to run the benchmarks shows its commands.