Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added note about documentation
  • Loading branch information
dganguli committed Mar 7, 2014
1 parent d109749 commit 3df572f
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
#pydruid
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.

#setup

#documentation

#examples

The following exampes show how to execute and analyze the results of three types of queries: timeseries, topN, and groupby. We will use these queries to ask simple questions about twitter's public data set.
Expand Down Expand Up @@ -111,6 +107,22 @@ plot(g, "tweets.png", layout=layout, vertex_size=2, bbox=(400, 400), margin=25,
![alt text](https://github.com/metamx/pydruid/raw/docs/docs/figures/twitter_graph.png "Social Network")


#documentation

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). If edited, documentation can be re-generated by running:

```python
make html
```

from within the docs directory, assuming Sphinx is installed on your machine.




0 comments on commit 3df572f

Please sign in to comment.