kopia lustrzana https://github.com/simonw/datasette
Moved getting started into separate docs page
rodzic
601934936c
commit
1feb5735da
|
@ -0,0 +1,112 @@
|
|||
Getting started
|
||||
===============
|
||||
|
||||
::
|
||||
|
||||
pip3 install datasette
|
||||
|
||||
Datasette requires Python 3.5 or higher.
|
||||
|
||||
Basic usage
|
||||
-----------
|
||||
|
||||
::
|
||||
|
||||
datasette serve path/to/database.db
|
||||
|
||||
This will start a web server on port 8001 - visit http://localhost:8001/
|
||||
to access the web interface.
|
||||
|
||||
``serve`` is the default subcommand, you can omit it if you like.
|
||||
|
||||
Use Chrome on OS X? You can run datasette against your browser history
|
||||
like so:
|
||||
|
||||
::
|
||||
|
||||
datasette ~/Library/Application\ Support/Google/Chrome/Default/History
|
||||
|
||||
Now visiting http://localhost:8001/History/downloads will show you a web
|
||||
interface to browse your downloads data:
|
||||
|
||||
.. figure:: https://static.simonwillison.net/static/2017/datasette-downloads.png
|
||||
:alt: Downloads table rendered by datasette
|
||||
|
||||
http://localhost:8001/History/downloads.json will return that data as
|
||||
JSON:
|
||||
|
||||
::
|
||||
|
||||
{
|
||||
"database": "History",
|
||||
"columns": [
|
||||
"id",
|
||||
"current_path",
|
||||
"target_path",
|
||||
"start_time",
|
||||
"received_bytes",
|
||||
"total_bytes",
|
||||
...
|
||||
],
|
||||
"table_rows": 576,
|
||||
"rows": [
|
||||
[
|
||||
1,
|
||||
"/Users/simonw/Downloads/DropboxInstaller.dmg",
|
||||
"/Users/simonw/Downloads/DropboxInstaller.dmg",
|
||||
13097290269022132,
|
||||
626688,
|
||||
0,
|
||||
...
|
||||
]
|
||||
]
|
||||
}
|
||||
|
||||
http://localhost:8001/History/downloads.jsono will return that data as
|
||||
JSON in a more convenient but less efficient format:
|
||||
|
||||
::
|
||||
|
||||
{
|
||||
...
|
||||
"rows": [
|
||||
{
|
||||
"start_time": 13097290269022132,
|
||||
"interrupt_reason": 0,
|
||||
"hash": "",
|
||||
"id": 1,
|
||||
"site_url": "",
|
||||
"referrer": "https://www.dropbox.com/downloading?src=index",
|
||||
...
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
datasette serve options
|
||||
-----------------------
|
||||
|
||||
::
|
||||
|
||||
$ datasette serve --help
|
||||
Usage: datasette serve [OPTIONS] [FILES]...
|
||||
|
||||
Serve up specified SQLite database files with a web UI
|
||||
|
||||
Options:
|
||||
-h, --host TEXT host for server, defaults to 127.0.0.1
|
||||
-p, --port INTEGER port for server, defaults to 8001
|
||||
--debug Enable debug mode - useful for development
|
||||
--reload Automatically reload if code change detected -
|
||||
useful for development
|
||||
--cors Enable CORS by serving Access-Control-Allow-
|
||||
Origin: *
|
||||
--page_size INTEGER Page size - default is 100
|
||||
--max_returned_rows INTEGER Max allowed rows to return at once - default is
|
||||
1000. Set to 0 to disable check entirely.
|
||||
--sql_time_limit_ms INTEGER Max time allowed for SQL queries in ms
|
||||
--load-extension TEXT Path to a SQLite extension to load
|
||||
--inspect-file TEXT Path to JSON file created using "datasette
|
||||
build"
|
||||
-m, --metadata FILENAME Path to JSON file containing license/source
|
||||
metadata
|
||||
--help Show this message and exit.
|
114
docs/index.rst
114
docs/index.rst
|
@ -16,120 +16,8 @@ Contents
|
|||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
getting_started
|
||||
custom_templates
|
||||
changelog
|
||||
|
||||
Getting started
|
||||
---------------
|
||||
|
||||
::
|
||||
|
||||
pip3 install datasette
|
||||
|
||||
Datasette requires Python 3.5 or higher.
|
||||
|
||||
Basic usage
|
||||
-----------
|
||||
|
||||
::
|
||||
|
||||
datasette serve path/to/database.db
|
||||
|
||||
This will start a web server on port 8001 - visit http://localhost:8001/
|
||||
to access the web interface.
|
||||
|
||||
``serve`` is the default subcommand, you can omit it if you like.
|
||||
|
||||
Use Chrome on OS X? You can run datasette against your browser history
|
||||
like so:
|
||||
|
||||
::
|
||||
|
||||
datasette ~/Library/Application\ Support/Google/Chrome/Default/History
|
||||
|
||||
Now visiting http://localhost:8001/History/downloads will show you a web
|
||||
interface to browse your downloads data:
|
||||
|
||||
.. figure:: https://static.simonwillison.net/static/2017/datasette-downloads.png
|
||||
:alt: Downloads table rendered by datasette
|
||||
|
||||
http://localhost:8001/History/downloads.json will return that data as
|
||||
JSON:
|
||||
|
||||
::
|
||||
|
||||
{
|
||||
"database": "History",
|
||||
"columns": [
|
||||
"id",
|
||||
"current_path",
|
||||
"target_path",
|
||||
"start_time",
|
||||
"received_bytes",
|
||||
"total_bytes",
|
||||
...
|
||||
],
|
||||
"table_rows": 576,
|
||||
"rows": [
|
||||
[
|
||||
1,
|
||||
"/Users/simonw/Downloads/DropboxInstaller.dmg",
|
||||
"/Users/simonw/Downloads/DropboxInstaller.dmg",
|
||||
13097290269022132,
|
||||
626688,
|
||||
0,
|
||||
...
|
||||
]
|
||||
]
|
||||
}
|
||||
|
||||
http://localhost:8001/History/downloads.jsono will return that data as
|
||||
JSON in a more convenient but less efficient format:
|
||||
|
||||
::
|
||||
|
||||
{
|
||||
...
|
||||
"rows": [
|
||||
{
|
||||
"start_time": 13097290269022132,
|
||||
"interrupt_reason": 0,
|
||||
"hash": "",
|
||||
"id": 1,
|
||||
"site_url": "",
|
||||
"referrer": "https://www.dropbox.com/downloading?src=index",
|
||||
...
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
datasette serve options
|
||||
-----------------------
|
||||
|
||||
::
|
||||
|
||||
$ datasette serve --help
|
||||
Usage: datasette serve [OPTIONS] [FILES]...
|
||||
|
||||
Serve up specified SQLite database files with a web UI
|
||||
|
||||
Options:
|
||||
-h, --host TEXT host for server, defaults to 127.0.0.1
|
||||
-p, --port INTEGER port for server, defaults to 8001
|
||||
--debug Enable debug mode - useful for development
|
||||
--reload Automatically reload if code change detected -
|
||||
useful for development
|
||||
--cors Enable CORS by serving Access-Control-Allow-
|
||||
Origin: *
|
||||
--page_size INTEGER Page size - default is 100
|
||||
--max_returned_rows INTEGER Max allowed rows to return at once - default is
|
||||
1000. Set to 0 to disable check entirely.
|
||||
--sql_time_limit_ms INTEGER Max time allowed for SQL queries in ms
|
||||
--load-extension TEXT Path to a SQLite extension to load
|
||||
--inspect-file TEXT Path to JSON file created using "datasette
|
||||
build"
|
||||
-m, --metadata FILENAME Path to JSON file containing license/source
|
||||
metadata
|
||||
--help Show this message and exit.
|
||||
|
||||
.. _Zeit Now: https://zeit.co/now
|
||||
|
|
Ładowanie…
Reference in New Issue