Msgpack docs

[GbotemiB]

trafficstars

Fixes #1187

TODO:

• [ ] Add unit tests and/or doctests in docstrings
• [ ] Add docstrings and API docs for any new/modified user-facing classes and functions
• [ ] New/modified features documented in docs/tutorial.rst
• [ ] Changes documented in docs/release.rst
• [ ] GitHub Actions have all passed
• [ ] Test coverage is 100% (Codecov passes)

[joshmoore]

Thanks for the PR, @GbotemiB. But if this only appears when running the tests, then I think would be more appropriate to add document around using requirements_dev_minimal.txt (and possibly windows_conda_dev.txt when using conda)

Edit: see https://zarr.readthedocs.io/en/stable/contributing.html#creating-a-development-environment for the current reference.

[joshmoore]

Another option (that others may want to comment on) would be to make the msgpack tests optional.

[GbotemiB]

HI @joshmoore, What i did instead is to add the msgpack dependency to setup.py since we the issue is encountered when running setup.py

[jakirkham]

Maybe we should just make this a hard requirement in Numcodecs? Currently it is just a soft requirement there

[GbotemiB]

Hi @jakirkham, can you brief me on how to make it a hard requirement in Numcodecs?

I think we can just include $ pip install -r requirements_dev_minimal.txt -r requirements_dev_numpy.txt before running setup.py instruction on the installation page.

[jakirkham]

We would move the extras_require into install_requires. We may also need to add it to some requirements files (like the RTFD requirements).

[GbotemiB]

We would move the extras_require into install_requires. We may also need to add it to some requirements files (like the RTFD requirements).

I can help with moving it from the extras_require to the install_require.

I have add it to the RFTD requirements on zarr-python.

[jakirkham]

Thanks @GbotemiB! 🙏