Skip to content

docs: correct optional dependency installation examples #330

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Likio3000 wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

docs: correct optional dependency installation examples #330

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions AUTHORS.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,11 @@ Code contributions:
- m-janicki


Documentation contributions:

- Likio3000


Suggestions and bug reporting:

- JiuLi Gao (gaojiuli)
Expand Down
5 changes: 5 additions & 0 deletions CHANGES.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
Changelog
=========

Unreleased
----------

* Correct installation examples for optional dependencies and shell quoting.

Version 7.4.1
-------------

Expand Down
9 changes: 5 additions & 4 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
----------------------------------
Expand All @@ -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 <https://github.com/cdgriffith/Box/wiki/Installation>`_ on installation details.

Expand All @@ -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!

Expand Down