Skip to content

Commit 745899d

Browse files
author
Scott Sanderson
committed
DOC: Update installation instructions.
1 parent b881b75 commit 745899d

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,13 @@ This repository is under development as part of the [Quantopian Research Environ
77

88
Getting Started
99
---------------
10-
0. Clone this repo via `git clone [email protected]:quantopian/pgcontents.git`.
11-
1. Install dependencies via `pip install -r requirements.txt`.
12-
2. Edit `pgcontents/alembic.ini` and point `sqlalchemy.url` to a postgres database you have read/write access to.
13-
3. Create/upgrade your database schema to the most recent migration by running: `alembic upgrade head`.
14-
4. Run the tests with `nosetests pgcontents/tests`.
15-
5. ???
16-
6. Profit!
10+
**Prerequisites:**
11+
- Write access to an empty [PostgreSQL](postgresql.org) database.
12+
- A Python installation with the latest master of [IPython Notebook](github.com/ipython/ipython).
13+
14+
**Installation**
15+
16+
0. Install `pgcontents` from PyPI via `pip install pgcontents`.
17+
1. Run `pgcontents init` to configure your database. You will be prompted for a database URL for pgcontents to use for storage.
18+
2. Configure IPython Notebook to use `PostgresContentsManager` as its storage backend. This can be done from the command line or by modifying your `ipython_notebook_config.py` file. See `examples/example_ipython_notebook_config.py` for an example config file.
19+
3. Enjoy your filesystem-free IPython experience!

0 commit comments

Comments
 (0)