<commit_before>pgcontents
==========

A PostgreSQL-backed implementation of [IPEP 27](https://github.com/ipython/ipython/wiki/IPEP-27:-Contents-Service).

This repository is under development as part of the [Quantopian Research Environment](https://www.quantopian.com/research), currently in Alpha.<commit_msg>Update README.md with Getting Started Section<commit_after>pgcontents
==========

A PostgreSQL-backed implementation of [IPEP 27](https://github.com/ipython/ipython/wiki/IPEP-27:-Contents-Service).

This repository is under development as part of the [Quantopian Research Environment](https://www.quantopian.com/research), currently in Alpha.

Getting Started
---------------
0. Clone this repo via `git clone <EMAIL>:quantopian/pgcontents.git.
1. Install dependencies via `pip install -r requirements.txt.
2. Edit `pgcontents/alembic.ini` and point `sqlalchemy.url` to a postgres database you have read/write access to.
3. Create/upgrade your database schema to the most recent migration by running: `alembic upgrade head`.
4. Run the tests with `nosetests pgcontents/tests`.
5. ???
6. Profit!
{'fraction_non_alphanumeric': 0.1286231884057971, 'fraction_numerical': 0.01358695652173913, 'mean_word_length': 4.8465608465608465, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 4, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3033182', 'n_tokens_mistral': 334, 'n_tokens_neox': 308, 'n_words': 106}