From b8604f20372f47eaac8793d5d71aba2b2ac752f0 Mon Sep 17 00:00:00 2001 From: Alex <100605452+Likio3000@users.noreply.github.com> Date: Wed, 23 Sep 2026 02:22:28 +1000 Subject: [PATCH] docs: correct optional dependency installation examples --- AUTHORS.rst | 5 +++++ CHANGES.rst | 5 +++++ README.rst | 9 +++++---- 3 files changed, 15 insertions(+), 4 deletions(-) diff --git a/AUTHORS.rst b/AUTHORS.rst index 6b44851..16ae30e 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -39,6 +39,11 @@ Code contributions: - m-janicki +Documentation contributions: + +- Likio3000 + + Suggestions and bug reporting: - JiuLi Gao (gaojiuli) diff --git a/CHANGES.rst b/CHANGES.rst index c4a347d..da2fecf 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,6 +1,11 @@ Changelog ========= +Unreleased +---------- + +* Correct installation examples for optional dependencies and shell quoting. + Version 7.4.1 ------------- diff --git a/README.rst b/README.rst index 9fc9f31..233dfc7 100644 --- a/README.rst +++ b/README.rst @@ -44,7 +44,7 @@ Install from command line .. code:: bash python -m pip install --upgrade pip - pip install python-box[all]~=7.0 --upgrade + pip install "python-box[all]~=7.0" --upgrade Install with selected dependencies ---------------------------------- @@ -54,9 +54,10 @@ for example, `[all]` is shorthand for: .. code:: bash - pip install python-box[ruamel.yaml,tomli_w,msgpack]~=7.0 --upgrade + pip install "python-box[ruamel.yaml,toml,msgpack]~=7.0" --upgrade -But you can also sub out `ruamel.yaml` for `PyYAML`. +But you can also sub out `ruamel.yaml` for `PyYAML`. To use ``tomli-w`` for TOML output, +select the ``tomli`` extra instead of ``toml``. Check out `more details `_ on installation details. @@ -81,7 +82,7 @@ You will then need `Cython` and `wheel` installed and then install (or re-instal .. code:: bash pip install Cython wheel - pip install python-box[all]~=7.0 --upgrade --force + pip install "python-box[all]~=7.0" --upgrade --force If you have any issues please open a github issue with the error you are experiencing!