README.md

   1 # datasette-connectors
   2
   3 [Datasette](https://github.com/simonw/datasette) is a Python module which provides a web interface and a JSON API for SQLite files. But, in conjuntion with Datasette-Connectors, it 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-connectors/blob/master/DEVELOPERS.md)).
   4
   5 ## Installation
   6
   7 Run `pip install datasette-connectors` to install both Datasette and Datasette-Connectors. Easy as pie!
   8
   9 ## Usage
  10
  11 You can use Datasette from the console in the traditional way:
  12
  13     datasette serve path/to/data.h5
  14
  15 This will start a web server on port 8001; then you can access to your data visiting [http://localhost:8001/](http://localhost:8001/)
  16
  17 Or you can use Datasette in your own Python programs:
  18
  19     from datasette_connectors import monkey; monkey.patch_datasette()
  20     from datasette_connectors import connectors; connectors.load()
  21
  22 For that, you need to patch the original Datasette and load the external connectors.
  23
  24 Read the [Datasette documentation](http://datasette.readthedocs.io/en/latest/) for more advanced options.