Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added link to docs
  • Loading branch information
dganguli committed Mar 7, 2014
1 parent 341bfbd commit 844047e
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
pydruid exposes a simple API to create, execute, and analyze [Druid](http://druid.io/) queries. pydruid can parse query results into [Pandas](http://pandas.pydata.org/) DataFrame objects for subsequent data analysis -- this offers a tight integration between [Druid](http://druid.io/), the [SciPy](http://www.scipy.org/stackspec.html) stack (for scientific computing) and [scikit-learn](http://scikit-learn.org/stable/) (for machine learning). Additionally, pydruid can export query results into TSV or JSON for further processing with your favorite tool, e.g., R, Julia, Matlab, Excel.

#documentation
Online documentation is here: https://pythonhosted.org/pydruid/.

pydruid is a [Sphinx](http://sphinx-doc.org/) project. You can view documentation locally by opening the following with a web browser:
```python
pydruid/docs/build/html/index.html
```
The docstrings are written in [ReStructuredText](http://docutils.sourceforge.net/rst.html). After an edit, documentation can be re-generated by running:
```python
make html
pydruid/docs>> make html
```
from within the docs directory (assuming Sphinx is installed on your machine).

#examples

Expand Down

0 comments on commit 844047e

Please sign in to comment.