1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
Installation
============
``msgspec`` may be installed via ``pip`` or ``conda``. Note that Python >= 3.8
is required. The basic install has no required dependencies.
**pip**
.. code-block:: shell
pip install msgspec
**conda**
.. code-block:: shell
conda install msgspec -c conda-forge
Optional Dependencies
---------------------
Depending on your platform, the base install of ``msgspec`` may not support
TOML_ or YAML_ without additional dependencies.
TOML
~~~~
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**
.. code-block:: shell
pip install "msgspec[toml]"
**conda**
.. code-block:: shell
conda install msgspec-toml -c conda-forge
YAML
~~~~
The YAML_ protocol requires PyYAML_ on all platforms. You may either install
this dependency manually, or depend on the ``yaml`` extra:
**pip**
.. code-block:: shell
pip install "msgspec[yaml]"
**conda**
.. code-block:: shell
conda install msgspec-yaml -c conda-forge
Installing from GitHub
----------------------
If you want wish to use a feature that hasn't been released yet, you may
install from the `development branch on GitHub
<https://github.com/jcrist/msgspec>`__ using ``pip``:
.. code-block:: shell
pip install git+https://github.com/jcrist/msgspec.git
.. _YAML: https://yaml.org
.. _TOML: https://toml.io
.. _PyYAML: https://pyyaml.org/
.. _tomli: https://github.com/hukkin/tomli
.. _tomli_w: https://github.com/hukkin/tomli-w
|
