datasette/docs/index.rst

Datasette
=========

*A tool for exploring and publishing data*

Datasette provides an instant, read-only JSON API for any SQLite
database. It also provides tools for packaging the database up as a
Docker container and deploying that container to hosting providers such
as `Zeit Now`_ or `Heroku`_.

Some examples: https://github.com/simonw/datasette/wiki/Datasettes

Contents
--------

.. toctree::
   :maxdepth: 2

   installation
   getting_started
   pages
   publish
   json_api
   sql_queries
   csv_export
   facets
   full_text_search
   spatialite
   metadata
   config
   introspection
   custom_templates
   plugins
   contributing
   changelog

.. _Zeit Now: https://zeit.co/now
.. _Heroku: https://www.heroku.com/
Added initial docs, including a changelog Docs initialized using this helpful guide: http://docs.readthedocs.io/en/latest/getting_started.html I used https://pypi.python.org/pypi/gitchangelog to kick-start the changelog. Closes #99 Refs #109 2017-11-16 15:11:00 +00:00			`Datasette`
			`=========`

New tagline: 'A tool for exploring and publishing data' 2018-07-11 01:57:54 +00:00			`A tool for exploring and publishing data`
Added initial docs, including a changelog Docs initialized using this helpful guide: http://docs.readthedocs.io/en/latest/getting_started.html I used https://pypi.python.org/pypi/gitchangelog to kick-start the changelog. Closes #99 Refs #109 2017-11-16 15:11:00 +00:00
			`Datasette provides an instant, read-only JSON API for any SQLite`
			`database. It also provides tools for packaging the database up as a`
			`Docker container and deploying that container to hosting providers such`
Mention Heroku in docs index page 2018-01-10 04:46:34 +00:00			as `Zeit Now`_ or `Heroku`_.
Added initial docs, including a changelog Docs initialized using this helpful guide: http://docs.readthedocs.io/en/latest/getting_started.html I used https://pypi.python.org/pypi/gitchangelog to kick-start the changelog. Closes #99 Refs #109 2017-11-16 15:11:00 +00:00
			`Some examples: https://github.com/simonw/datasette/wiki/Datasettes`

			`Contents`
			`--------`

			`.. toctree::`
			`:maxdepth: 2`

Installation instructions, including docker image - closes #328 2018-06-28 03:59:58 +00:00			`installation`
Moved getting started into separate docs page 2017-11-30 18:27:00 +00:00			`getting_started`
Docs for IndexView, TableView, RowView, closes #299 Also removed xfail from test_view_classes_are_documented, so any future *View classes that are added without documentation will cause the tests to fail. 2018-07-28 04:21:42 +00:00			`pages`
Docs for datasette publish and package, closes #337 Also introduced a new mechanism for ensuring the --help examples in the documentation reflect the current output of the --help commands, via a new update-docs-help.sh script. Closes #336 2018-07-11 02:04:13 +00:00			`publish`
Database/Table views inherit source/license/source_url/license_url metadata If you set the source_url/license_url/source/license fields in your root metadata those values will now be inherited all the way down to the database and table templates. The title/description are NOT inherited. Also added unit tests for the HTML generated by the metadata. Refs #185 2018-03-27 16:18:32 +00:00			`json_api`
Documentation for custom SQL queries http://datasette.readthedocs.io/en/latest/sql_queries.html Closes #20 2017-12-05 17:43:59 +00:00			`sql_queries`
Docs for CSV export, refs #266 2018-06-18 14:12:21 +00:00			`csv_export`
Initial implementation of facets, plus tests and docs Refs #255 2018-05-12 22:29:06 +00:00			`facets`
Documentation for SQLite full-text search support, closes #253 2018-05-12 12:06:38 +00:00			`full_text_search`
Initial documentation on using SpatiaLite https://datasette.readthedocs.io/en/latest/spatialite.html 2018-05-26 18:04:09 +00:00			`spatialite`
Documentation for metadata.json and "datasette skeleton" command http://datasette.readthedocs.io/en/latest/metadata.html Closes #166 2017-12-07 17:19:35 +00:00			`metadata`
Renamed --limit to --config, added --help-config, closes #274 Removed the --page_size= argument to datasette serve in favour of: datasette serve --config default_page_size:50 mydb.db Added new help section: $ datasette --help-config Config options: default_page_size Default page size for the table view (default=100) max_returned_rows Maximum rows that can be returned from a table or custom query (default=1000) sql_time_limit_ms Time limit for a SQL query in milliseconds (default=1000) default_facet_size Number of values to return for requested facets (default=30) facet_time_limit_ms Time limit for calculating a requested facet (default=200) facet_suggest_time_limit_ms Time limit for calculating a suggested facet (default=50) 2018-05-20 17:01:49 +00:00			`config`
Added docs for introspection endpoints https://datasette.readthedocs.io/en/latest/introspection.html 2018-05-20 21:28:53 +00:00			`introspection`
Re-ordered docs index page 2017-12-06 18:27:50 +00:00			`custom_templates`
Initial documentation for plugins, closes #213 https://datasette.readthedocs.io/en/latest/plugins.html 2018-04-16 15:12:09 +00:00			`plugins`
Started contributing docs: setting up a dev environment https://datasette.readthedocs.io/en/latest/contributing.html 2018-10-27 17:12:19 +00:00			`contributing`
Added initial docs, including a changelog Docs initialized using this helpful guide: http://docs.readthedocs.io/en/latest/getting_started.html I used https://pypi.python.org/pypi/gitchangelog to kick-start the changelog. Closes #99 Refs #109 2017-11-16 15:11:00 +00:00			`changelog`

			`.. _Zeit Now: https://zeit.co/now`
Mention Heroku in docs index page 2018-01-10 04:46:34 +00:00			`.. _Heroku: https://www.heroku.com/`