diff options
author | Hugo van Kemenade <hugovk@users.noreply.github.com> | 2020-08-12 16:12:57 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-08-12 16:12:57 +0300 |
commit | 5fa4496f9d3996c27f5252bba8cdd09e1fc278ef (patch) | |
tree | 0a84866822f783a8ed882052823572a976338862 | |
parent | bc8438bda4b33930d9bfa6e56efd74e111900be4 (diff) | |
download | tablib-5fa4496f9d3996c27f5252bba8cdd09e1fc278ef.tar.gz |
Suggest quotes when pip installing with optional dependencies (#474)
-rw-r--r-- | docs/formats.rst | 14 | ||||
-rw-r--r-- | docs/install.rst | 6 | ||||
-rw-r--r-- | src/tablib/formats/__init__.py | 2 | ||||
-rw-r--r-- | src/tablib/formats/_df.py | 2 | ||||
-rwxr-xr-x | tests/test_tablib.py | 2 |
5 files changed, 13 insertions, 13 deletions
diff --git a/docs/formats.rst b/docs/formats.rst index 12ea52d..0c46733 100644 --- a/docs/formats.rst +++ b/docs/formats.rst @@ -27,7 +27,7 @@ For example:: dataset.export("cli", tablefmt="github") dataset.export("cli", tablefmt="grid") -This format is optional, install Tablib with ``pip install tablib[cli]`` to +This format is optional, install Tablib with ``pip install "tablib[cli]"`` to make the format available. csv @@ -83,7 +83,7 @@ df (DataFrame) ============== Import/export using the pandas_ DataFrame format. This format is optional, -install Tablib with ``pip install tablib[pandas]`` to make the format available. +install Tablib with ``pip install "tablib[pandas]"`` to make the format available. .. _pandas: https://pandas.pydata.org/ @@ -94,7 +94,7 @@ The ``html`` format is currently export-only. The exports produce an HTML page with the data in a ``<table>``. If headers have been set, they will be used as table headers. -This format is optional, install Tablib with ``pip install tablib[html]`` to +This format is optional, install Tablib with ``pip install "tablib[html]"`` to make the format available. jira @@ -132,7 +132,7 @@ ods Export data in OpenDocument Spreadsheet format. The ``ods`` format is currently export-only. -This format is optional, install Tablib with ``pip install tablib[ods]`` to +This format is optional, install Tablib with ``pip install "tablib[ods]"`` to make the format available. .. admonition:: Binary Warning @@ -183,7 +183,7 @@ xls Import/export data in Legacy Excel Spreadsheet representation. -This format is optional, install Tablib with ``pip install tablib[xls]`` to +This format is optional, install Tablib with ``pip install "tablib[xls]"`` to make the format available. .. note:: @@ -203,7 +203,7 @@ xlsx Import/export data in Excel 07+ Spreadsheet representation. -This format is optional, install Tablib with ``pip install tablib[xlsx]`` to +This format is optional, install Tablib with ``pip install "tablib[xlsx]"`` to make the format available. .. note:: @@ -232,7 +232,7 @@ returned instead. Import assumes (for now) that headers exist. -This format is optional, install Tablib with ``pip install tablib[yaml]`` to +This format is optional, install Tablib with ``pip install "tablib[yaml]"`` to make the format available. .. _YAML: https://yaml.org diff --git a/docs/install.rst b/docs/install.rst index 62e486d..e3cb3f3 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -26,19 +26,19 @@ formats available: .. code-block:: console - $ pip install tablib[xlsx] + $ pip install "tablib[xlsx]" Or all possible formats: .. code-block:: console - $ pip install tablib[all] + $ pip install "tablib[all]" which is equivalent to: .. code-block:: console - $ pip install tablib[html, pandas, ods, xls, xlsx, yaml] + $ pip install "tablib[html, pandas, ods, xls, xlsx, yaml]" ------------------- Download the Source diff --git a/src/tablib/formats/__init__.py b/src/tablib/formats/__init__.py index 5162a86..31b54db 100644 --- a/src/tablib/formats/__init__.py +++ b/src/tablib/formats/__init__.py @@ -122,7 +122,7 @@ class Registry: if key in uninstalled_format_messages: raise UnsupportedFormat( "The '{key}' format is not available. You may want to install the " - "{package_name} (or `pip install tablib[{extras_name}]`).".format( + "{package_name} (or `pip install \"tablib[{extras_name}]\"`).".format( **uninstalled_format_messages[key], key=key ) ) diff --git a/src/tablib/formats/_df.py b/src/tablib/formats/_df.py index d8bf877..872f6be 100644 --- a/src/tablib/formats/_df.py +++ b/src/tablib/formats/_df.py @@ -30,7 +30,7 @@ class DataFrameFormat: if DataFrame is None: raise NotImplementedError( 'DataFrame Format requires `pandas` to be installed.' - ' Try `pip install tablib[pandas]`.') + ' Try `pip install "tablib[pandas]"`.') dataframe = DataFrame(dset.dict, columns=dset.headers) return dataframe diff --git a/tests/test_tablib.py b/tests/test_tablib.py index f4c0109..d78bfa7 100755 --- a/tests/test_tablib.py +++ b/tests/test_tablib.py @@ -57,7 +57,7 @@ class TablibTestCase(BaseTestCase): # A known format but uninstalled del registry._formats['ods'] msg = (r"The 'ods' format is not available. You may want to install the " - "odfpy package \\(or `pip install tablib\\[ods\\]`\\).") + "odfpy package \\(or `pip install \"tablib\\[ods\\]\"`\\).") with self.assertRaisesRegex(UnsupportedFormat, msg): data.export('ods') |