datasette/docs/index.rst

Datasette
=========

|PyPI| |Changelog| |Python 3.x| |Tests| |License| |docker:
datasette|

.. |PyPI| image:: https://img.shields.io/pypi/v/datasette.svg
   :target: https://pypi.org/project/datasette/
.. |Changelog| image:: https://img.shields.io/github/v/release/simonw/datasette?label=changelog
   :target: https://docs.datasette.io/en/stable/changelog.html
.. |Python 3.x| image:: https://img.shields.io/pypi/pyversions/datasette.svg?logo=python&logoColor=white
   :target: https://pypi.org/project/datasette/
.. |Tests| image:: https://github.com/simonw/datasette/workflows/Test/badge.svg
   :target: https://github.com/simonw/datasette/actions?query=workflow%3ATest
.. |License| image:: https://img.shields.io/badge/license-Apache%202.0-blue.svg
   :target: https://github.com/simonw/datasette/blob/main/LICENSE
.. |docker: datasette| image:: https://img.shields.io/badge/docker-datasette-blue
   :target: https://hub.docker.com/r/datasetteproject/datasette

*An open source multi-tool for exploring and publishing data*

Datasette is a tool for exploring and publishing data. It helps people take data of any shape or size and publish that as an interactive, explorable website and accompanying API.

Datasette is aimed at data journalists, museum curators, archivists, local governments and anyone else who has data that they wish to share with the world. It is part of a :ref:`wider ecosystem of tools and plugins <ecosystem>` dedicated to making working with structured data as productive as possible.

`Explore a demo <https://fivethirtyeight.datasettes.com/fivethirtyeight>`__, watch `a presentation about the project <https://static.simonwillison.net/static/2018/pybay-datasette/>`__ or :ref:`getting_started_glitch`.

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

Support questions, feedback? Join our `GitHub Discussions forum <https://github.com/simonw/datasette/discussions>`__.

Contents
--------

.. toctree::
   :maxdepth: 3

   getting_started
   installation
   ecosystem
   pages
   publish
   deploying
   json_api
   sql_queries
   authentication
   performance
   csv_export
   binary_data
   facets
   full_text_search
   spatialite
   metadata
   config
   introspection
   custom_templates
   plugins
   writing_plugins
   plugin_hooks
   testing_plugins
   internals
   contributing
   changelog
Removed accidental R 2019-05-16 13:27:08 +00:00			`Datasette`
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			`=========`

Fixed undefined reference in index.rst 2020-08-19 17:22:33 +00:00			`\|PyPI\| \|Changelog\| \|Python 3.x\| \|Tests\| \|License\| \|docker:`
Add badges to documentation index 2020-05-03 15:46:49 +00:00			`datasette\|`

			`.. \|PyPI\| image:: https://img.shields.io/pypi/v/datasette.svg`
			`:target: https://pypi.org/project/datasette/`
Don't show prereleases on changelog badge 2020-06-20 15:48:39 +00:00			`.. \|Changelog\| image:: https://img.shields.io/github/v/release/simonw/datasette?label=changelog`
Docs now live at docs.datasette.io (#937) 2020-08-15 23:57:05 +00:00			`:target: https://docs.datasette.io/en/stable/changelog.html`
Add badges to documentation index 2020-05-03 15:46:49 +00:00			`.. \|Python 3.x\| image:: https://img.shields.io/pypi/pyversions/datasette.svg?logo=python&logoColor=white`
			`:target: https://pypi.org/project/datasette/`
Run CI on GitHub Actions, not Travis * Run CI on GitHub Actions, not Travis - refs #940 * Update documentation refs to Travis * Release action now runs parallel tests, then pushes to PyPI, then Docker Hub 2020-08-18 05:09:34 +00:00			`.. \|Tests\| image:: https://github.com/simonw/datasette/workflows/Test/badge.svg`
			`:target: https://github.com/simonw/datasette/actions?query=workflow%3ATest`
Add badges to documentation index 2020-05-03 15:46:49 +00:00			`.. \|License\| image:: https://img.shields.io/badge/license-Apache%202.0-blue.svg`
Link to discussions forum 2020-08-11 02:49:22 +00:00			`:target: https://github.com/simonw/datasette/blob/main/LICENSE`
Add badges to documentation index 2020-05-03 15:46:49 +00:00			`.. \|docker: datasette\| image:: https://img.shields.io/badge/docker-datasette-blue`
			`:target: https://hub.docker.com/r/datasetteproject/datasette`

An open source multi-tool for exploring and publishing data 2020-07-07 19:54:54 +00:00			`An open source multi-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
More human friendly 'what is Datasette' intro text 2018-11-05 06:04:23 +00:00			`Datasette is a tool for exploring and publishing data. It helps people take data of any shape or size and publish that as an interactive, explorable website and accompanying API.`
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
Examples of things you can do with plugins 2019-11-27 19:19:11 +00:00			Datasette is aimed at data journalists, museum curators, archivists, local governments and anyone else who has data that they wish to share with the world. It is part of a :ref:`wider ecosystem of tools and plugins <ecosystem>` dedicated to making working with structured data as productive as possible.
More human friendly 'what is Datasette' intro text 2018-11-05 06:04:23 +00:00
'datasette --get' option, closes #926 Also made a start on the datasette.utils.testing module, refs #898 2020-08-12 00:24:40 +00:00			`Explore a demo <https://fivethirtyeight.datasettes.com/fivethirtyeight>`__, watch `a presentation about the project <https://static.simonwillison.net/static/2018/pybay-datasette/>`__ or :ref:`getting_started_glitch`.
More human friendly 'what is Datasette' intro text 2018-11-05 06:04:23 +00:00
			`More examples: https://github.com/simonw/datasette/wiki/Datasettes`
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
Link to discussions forum 2020-08-11 02:49:22 +00:00			Support questions, feedback? Join our `GitHub Discussions forum <https://github.com/simonw/datasette/discussions>`__.

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			`Contents`
			`--------`

			`.. toctree::`
register_routes() plugin hook (#819) Fixes #215 2020-06-09 03:12:06 +00:00			`:maxdepth: 3`
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
Moved getting started into separate docs page 2017-11-30 18:27:00 +00:00			`getting_started`
Re-ordered documentation index page 2019-05-16 05:14:33 +00:00			`installation`
			`ecosystem`
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`
Docs on deploying with systemd, refs #514 2020-10-08 22:47:37 +00:00			`deploying`
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`
Added /-/permissions debug tool, closes #788 Also started the authentication.rst docs page, refs #786. Part of authentication work, refs #699. 2020-06-01 05:00:36 +00:00			`authentication`
New performance documentation, closes #421 2019-05-19 05:31:03 +00:00			`performance`
Docs for CSV export, refs #266 2018-06-18 14:12:21 +00:00			`csv_export`
Binary data documentation, closes #1047 2020-10-31 21:37:58 +00:00			`binary_data`
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`
Split out new 'Writing plugins' page, refs #687 2020-06-22 02:37:48 +00:00			`writing_plugins`
Move plugin hooks docs to plugin_hooks.rst, refs #687 2020-06-22 00:33:48 +00:00			`plugin_hooks`
New 'Testing plugins' page, closes #687 2020-06-22 03:53:42 +00:00			`testing_plugins`
.execute_write() and .execute_write_fn() methods on Database (#683) Closes #682. 2020-02-25 04:45:08 +00:00			`internals`
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`