Skip to content

Commit 9b6300c

Browse files
authored
wrap pip install statements including optional requirements in quotes (piccolo-orm#159)
1 parent e6466b3 commit 9b6300c

File tree

6 files changed

+12
-12
lines changed

6 files changed

+12
-12
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,13 +72,13 @@ await b.remove().run()
7272
Installing with PostgreSQL driver:
7373

7474
```
75-
pip install piccolo[postgres]
75+
pip install 'piccolo[postgres]'
7676
```
7777

7878
Installing with SQLite driver:
7979

8080
```
81-
pip install piccolo[sqlite]
81+
pip install 'piccolo[sqlite]'
8282
```
8383

8484
## Building a web app?

docs/src/piccolo/getting_started/installing_piccolo.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ Now install piccolo, ideally inside a `virtualenv <https://docs.python-guide.org
2222
pip install piccolo
2323
2424
# Install Piccolo with PostgreSQL driver:
25-
pip install piccolo[postgres]
25+
pip install 'piccolo[postgres]'
2626
2727
# Install Piccolo with SQLite driver:
28-
pip install piccolo[sqlite]
28+
pip install 'piccolo[sqlite]'
2929
3030
# Optional: orjson for improved JSON serialisation performance
31-
pip install piccolo[orjson]
31+
pip install 'piccolo[orjson]'
3232
3333
# Optional: uvloop as default event loop instead of asyncio
3434
# If using Piccolo with Uvicorn, Uvicorn will set uvloop as
3535
# default event loop if installed
36-
pip install piccolo[uvloop]
36+
pip install 'piccolo[uvloop]'

docs/src/piccolo/query_clauses/output.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ To return the data as a JSON string:
2626
Piccolo can use `orjson <https://github.com/ijl/orjson>`_ for JSON serialisation,
2727
which is blazing fast, and can handle most Python types, including dates,
2828
datetimes, and UUIDs. To install Piccolo with orjson support use
29-
``pip install piccolo[orjson]``.
29+
``pip install 'piccolo[orjson]'``.
3030

3131
as_list
3232
~~~~~~~

piccolo/apps/playground/commands/run.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ def run(
145145
import IPython # type: ignore
146146
except ImportError:
147147
sys.exit(
148-
"Install iPython using `pip install piccolo[playground,sqlite]` "
148+
"Install iPython using `pip install 'piccolo[playground,sqlite]'` "
149149
"to use this feature."
150150
)
151151

piccolo/conf/apps.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -330,12 +330,12 @@ def get_piccolo_conf_module(
330330
if str(exc) == "No module named 'asyncpg'":
331331
raise ModuleNotFoundError(
332332
"PostgreSQL driver not found. "
333-
"Try running 'pip install piccolo[postgres]'"
333+
"Try running `pip install 'piccolo[postgres]'`"
334334
)
335335
elif str(exc) == "No module named 'aiosqlite'":
336336
raise ModuleNotFoundError(
337337
"SQLite driver not found. "
338-
"Try running 'pip install piccolo[sqlite]'"
338+
"Try running `pip install 'piccolo[sqlite]'`"
339339
)
340340
else:
341341
raise exc

piccolo/utils/lazy_loader.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,12 @@ def _load(self) -> types.ModuleType:
3838
if str(exc) == "No module named 'asyncpg'":
3939
raise ModuleNotFoundError(
4040
"PostgreSQL driver not found. "
41-
"Try running 'pip install piccolo[postgres]'"
41+
"Try running `pip install 'piccolo[postgres]'`"
4242
)
4343
elif str(exc) == "No module named 'aiosqlite'":
4444
raise ModuleNotFoundError(
4545
"SQLite driver not found. "
46-
"Try running 'pip install piccolo[sqlite]'"
46+
"Try running `pip install 'piccolo[sqlite]'`"
4747
)
4848
else:
4949
raise exc

0 commit comments

Comments
 (0)