Install

Pycrdt can be installed through PyPI or conda-forge.

With pip

pip install pycrdt

With micromamba

We recommend using micromamba to manage conda-forge environments (see micromamba's installation instructions). First create an environment, here called my_env, and activate it:

micromamba create -n my_env
micromamba activate my_env

Then install pycrdt.

micromamba install -c conda-forge pycrdt

Development install

You first need to clone the repository:

git clone https://github.com/jupyter-server/pycrdt.git
cd pycrdt

We recommend working in a conda environment. In order to build pycrdt, you will need pip and the Rust compiler:

micromamba create -n pycrdt-dev
micromamba activate pycrdt-dev
micromamba install -c conda-forge pip rust

Then install pycrdt in editable mode:

pip install -e .

This will build the Rust extension using maturin. If you make changes to the Python code only, you don't need to recompile anything, changes will be reflected the next time you run the Python interpreter. If you make changes to the Rust code, you need to recompile it but you don't need to reinstall pycrdt, you can just re-build the Rust extension with:

# install maturin only once:
pip install maturin
# build the Rust extension each time the Rust code changes:
maturin develop