Skip to content

Commit 01056b4

Browse files
author
Scott Sanderson
authored
DOC: Update README with 3/4 install notes.
1 parent 4f8843e commit 01056b4

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Getting Started
1414

1515
**Installation:**
1616

17-
0. Install `pgcontents` from PyPI via `pip install pgcontents`.
18-
1. Run `pgcontents init` to configure your database. You will be prompted for a database URL for pgcontents to use for storage.
17+
0. Install `pgcontents` from PyPI via `pip install pgcontents[ipy4]`. (This will install pgcontents in a manner compatible with a recent Jupyter Notebook version. To install pgcontents with support for the legacy IPython 3.x series, run `pip install pgcontents[ipy3]`).
18+
1. Run `pgcontents init` to configure your database. You will be prompted for a database URL for pgcontents to use for storage. (Alternatively, you can set the PGCONTENTS_DB_URL environment variable, or pass `--db-url` on the command line).
1919
2. Configure IPython/Jupyter to use pgcontents as its storage backend. This can be done from the command line or by modifying your notebook config file. For IPython 3.x on a Unix-like system, your notebok config will be located located at ``~/.ipython/profile_default/ipython_notebook_config.py``. For Jupyter Notebook, it will will be located at ``~/.jupyter/jupyter_notebook_config.py``. See the ``examples`` directory for example configuration files.
2020
3. Enjoy your filesystem-free IPython experience!

0 commit comments

Comments
 (0)