You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-7Lines changed: 10 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,10 +7,13 @@ This repository is under development as part of the [Quantopian Research Environ
7
7
8
8
Getting Started
9
9
---------------
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.
0 commit comments