Installation¶

msgspec-x may be installed via pip or conda. Note that Python >= 3.9 is required. The basic install has no required dependencies.

pip

pip install msgspec-x

conda

conda install msgspec-x -c conda-forge

Note

Do not install both msgspec and msgspec-x in the same environment.

Optional Dependencies¶

Depending on your platform, the base install of msgspec-x may not support TOML or YAML without additional dependencies.

The TOML protocol requires:

Python < 3.11: tomli and tomli_w for reading and writing TOML.
Python >= 3.11: tomli_w for writing TOML. Reading TOML is done using the standard library’s tomllib and requires no additional dependencies.

You may either install these dependencies manually, or depend on the toml extra:

pip

pip install "msgspec-x[toml]"

conda

conda install msgspec-x-toml -c conda-forge

The YAML protocol requires PyYAML on all platforms. You may either install this dependency manually, or depend on the yaml extra:

pip

pip install "msgspec-x[yaml]"

conda

conda install msgspec-x-yaml -c conda-forge

If you want wish to use a feature that hasn’t been released yet, you may install from the development branch on GitHub using pip:

pip install git+https://github.com/jcrist/msgspec.git