57e027049ead7f5689b7bdb576d46d5b8ded94bd
[datasette-pytables.git] / README.md
1 [![Build Status](https://travis-ci.org/PyTables/datasette-pytables.svg?branch=master)](https://travis-ci.org/PyTables/datasette-pytables)
2
3
4 # datasette-pytables
5
6 Datasette-PyTables provides a web interface and a JSON API for [PyTables](https://github.com/PyTables/PyTables) files, allowing them to be accessible for e.g. Javascript programs. It works in conjunction with [Datasette-Core](https://github.com/PyTables/datasette-core), a trivial fork of the original [Datasette](https://github.com/simonw/datasette), which provides a web interface for SQLite files.  This fork is able to work with SQLite files, like the original project, but can accept external connectors for any kind of database files, so you can develop your own connector for your favourite data container if you want (read [developers doc](https://github.com/PyTables/datasette-pytables/blob/master/DEVELOPERS.md)).
7
8 ## Installation
9
10 Run `pip install datasette-pytables` to install both the forked version of Datasette and the PyTables connector. Easy as pie!
11
12 ## How to serve PyTables files
13
14     datasette serve path/to/data.h5
15
16 This will start a web server on port 8001; then you can access to your data visiting [http://localhost:8001/](http://localhost:8001/)
17
18 Read the [Datasette documentation](http://datasette.readthedocs.io/en/latest/) for more advanced options.
19
20 See how a typical Table query looks like in the Datasette-PyTables web interface:
21
22 ![Datasette Screenshot](/images/Datasette-Screenshot.png)