remote/datasette
1
0
Fork 0
mirror of https://github.com/simonw/datasette.git synced 2026-09-16 13:34:07 +02:00
Code Issues Projects Releases Packages Wiki Activity
3,487 commits 196 branches 181 tags 371 MiB
Commit graph

67 commits

Author SHA1 Message Date
Alex Garcia
23efb08042 Add a plugin telemetry kit: public registry API, linked_root_span_kwargs, test helpers, docs 
A survey of five plugin OTel plans (datasette-paper, -agent, -litestream,
-accounts, -cron) found every one hand-copying the same core machinery:
the registry classes, the conformance-test harness, the pytest fixtures,
the bucket boundaries and the detached-root-with-Link recipe. This makes
that machinery importable instead:

- The registry classes are documented public API. Attribute gains
  values= (a closed enum the conformance helpers enforce - what makes an
  attribute safe as a metric dimension); SpanName gains prefix=True for
  span families like "chat {model}" whose names share a fixed prefix,
  matched by span_for() after exact names. span_for()/attribute helpers
  accept a spans= tuple so plugin registries can use them.
- datasette.telemetry.linked_root_span_kwargs(): the root-span-with-Link
  shape for work a request caused without containing - background jobs,
  scheduled ticks, block=False writes. Core's own write thread now uses
  it instead of building the kwargs inline.
- datasette.telemetry_testing: the session provider fixtures, otel_spans
  / otel_metrics, a two-way registry conformance checker (including enum
  and prefix handling, filtered by instrumentation scope) and an
  assert_package_never_imports_sdk() guard. Core's conftest now imports
  these instead of defining them, so the suite consumes the kit exactly
  as a plugin's would.
- New "Telemetry for plugin authors" docs page: scope discipline,
  registry usage, privacy/cardinality rules, named-callable guidance,
  request_span(), the background root-with-link convention (one root per
  tick, always emitted), provider-ordering facts and known caveats.
  request_span() is now documented public API.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012U7coQfVu8nK2R4q2mCULA
 2026-09-14 09:04:13 -07:00
Simon Willison
a55ae2adfc Generated template context documentation, closes #1510 
docs/template_context.rst is generated by cog from the manifest in
datasette/template_contexts.py, following the json_api_doc.py pattern.
It documents the base context available on every page plus the
database, query, table and row pages, including the stability policy
for custom template authors.

Refs #2127

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
 2026-06-11 07:47:15 -07:00
Simon Willison
9dc2a3ffe5 Removed broken refs to Glitch, closes #2503 2025-09-28 21:15:58 -07:00
Simon Willison
bd7d3bb70f Tweaks and improvements to upgrade guide, refs ##2374 
Also refs #2381
 2024-08-05 12:11:17 -07:00
Alex Garcia
169ee5d710
 		Initial upgrade guide for v0.XX to v1 2024-08-05 10:35:38 -07:00
Simon Willison
503545b203 JavaScript plugins documentation, closes #2250 2024-02-05 11:47:17 -08:00
Simon Willison
bcc4f6bf1f
 		track_event() mechanism for analytics and plugins 
* Closes #2240
* Documentation for event plugin hooks, refs #2240
* Include example track_event plugin in docs, refs #2240
* Tests for track_event() and register_events() hooks, refs #2240
* Initial documentation for core events, refs #2240
* Internals documentation for datasette.track_event()
 2024-01-31 15:21:40 -08:00
Simon Willison
a4b401f470 Updated Discord link, refs #2196 
This issue reminded me to use the datasette.io/discord redirect URL.
 2023-10-12 14:57:04 -07:00
Alex Garcia
b2ec8717c3
 		Plugin configuration now lives in datasette.yaml/json 
* Checkpoint, moving top-level plugin config to datasette.json
* Support database-level and table-level plugin configuration in datasette.yaml

Refs #2093
 2023-09-13 14:06:25 -07:00
Simon Willison
42ca574720 Removed accidental test code I added, refs #1153 2023-07-08 12:50:22 -07:00
Simon Willison
d7b21a8623 metadata.yaml now treated as default in docs 
Added sphinx-inline-tabs to provide JSON and YAML tabs to show examples.

Refs #1153
 2023-07-08 09:37:01 -07:00
Simon Willison
6c0ba7c00c Improved CLI reference documentation, refs #1787 2022-08-18 14:52:04 -07:00
Simon Willison
950cc7677f
 		Fix missing Discord image 
Refs https://github.com/simonw/datasette.io/issues/112
 2022-07-14 15:18:28 -07:00
Simon Willison
c133545fe9
 		Make discord badge lowercase 
Refs https://github.com/simonw/datasette.io/issues/112
 2022-07-14 15:04:38 -07:00
Simon Willison
5d76c1f81b
 		Discord badge 
Refs https://github.com/simonw/datasette.io/issues/112
 2022-07-14 15:03:33 -07:00
Simon Willison
dd94157f89
 		Link to tutorials from documentation index page 2022-02-27 10:04:03 -08:00
Simon Willison
76d66d5b2b Tweak order of documentation contents 2022-01-13 16:30:00 -08:00
Simon Willison
4b23f01f3e CLI reference docs, maintained by cog - refs #1594 2022-01-13 13:35:54 -08:00
Simon Willison
e0b54d0911 No longer using Wiki for examples 2020-12-10 15:20:43 -08:00
Simon Willison
5a77f7a649 Updated docs renaming config to settings 
- config.html is now settings.html
- ConfigOption in app.py is now Setting
- updated documentation unit tests

Refs #1106
 2020-11-24 13:22:33 -08:00
Simon Willison
fa4de7551c Binary data documentation, closes #1047 2020-10-31 14:37:58 -07:00
Simon Willison
2458d7b766 Docs on deploying with systemd, refs #514 2020-10-08 15:47:37 -07:00
Simon Willison
86aefc39c5 Fixed undefined reference in index.rst 2020-08-19 10:22:33 -07:00
Simon Willison
5e0b72247e
 		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-17 22:09:34 -07:00
Simon Willison
41ddc19756
 		Docs now live at docs.datasette.io (#937) 2020-08-15 16:57:05 -07:00
Simon Willison
e139a7619f
 		'datasette --get' option, closes #926 
Also made a start on the datasette.utils.testing module, refs #898
 2020-08-11 17:24:40 -07:00
Simon Willison
e21face1d7
 		Link to discussions forum 2020-08-10 19:49:22 -07:00
Simon Willison
ba739b2457
 		An open source multi-tool for exploring and publishing data 2020-07-07 12:54:54 -07:00
Simon Willison
000528192e New 'Testing plugins' page, closes #687 2020-06-21 20:53:42 -07:00
Simon Willison
c32af6f693 Split out new 'Writing plugins' page, refs #687 2020-06-21 19:37:48 -07:00
Simon Willison
36e77e1006 Move plugin hooks docs to plugin_hooks.rst, refs #687 2020-06-21 17:34:10 -07:00
Simon Willison
d1640ba76b Don't show prereleases on changelog badge 2020-06-20 08:48:39 -07:00
Simon Willison
f5e79adf26
 		register_routes() plugin hook (#819) 
Fixes #215
 2020-06-08 20:12:06 -07:00
Simon Willison
dfdbdf378a Added /-/permissions debug tool, closes #788 
Also started the authentication.rst docs page, refs #786.

Part of authentication work, refs #699.
 2020-05-31 22:00:36 -07:00
Simon Willison
d996d4122b
 		Add badges to documentation index 2020-05-03 08:46:49 -07:00
Simon Willison
5f4aeb1f19 Removed documentation for Zeit Now v1, refs #710 2020-03-24 15:45:24 -07:00
Simon Willison
a093c5f79f
 		.execute_write() and .execute_write_fn() methods on Database (#683) 
Closes #682.
 2020-02-24 20:45:07 -08:00
Simon Willison
3ffb8f3b98 .add_database() and .remove_database() methods, refs #671 
Also made a start on the Datasette class documentation, refs #576
 2020-02-13 17:27:57 -08:00
Simon Willison
a562f29655 Examples of things you can do with plugins 2019-11-27 11:19:11 -08:00
Simon Willison
81ba98a509 New performance documentation, closes #421 2019-05-18 22:31:03 -07:00
Simon Willison
1937026766
 		Removed accidental R 2019-05-16 06:27:08 -07:00
Simon Willison
f31b9fe5ca
 		Another link to Glitch 2019-05-16 06:26:46 -07:00
Simon Willison
725b5b6a69 Re-ordered documentation index page 2019-05-15 22:14:33 -07:00
Simon Willison
b944bcd0f0 Added documentation on the Datasette Ecosystem 
https://datasette.readthedocs.io/en/latest/ecosystem.html
 2019-01-31 19:36:07 -08:00
Simon Willison
5debabd3fb
 		More human friendly 'what is Datasette' intro text 2018-11-04 22:04:23 -08:00
Simon Willison
7dda8898c1
 		Started contributing docs: setting up a dev environment 
https://datasette.readthedocs.io/en/latest/contributing.html
 2018-10-27 10:13:08 -07:00
Simon Willison
788a542d3c
 		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-27 21:21:42 -07:00
Simon Willison
aec3ae5323
 		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-10 19:05:46 -07:00
Simon Willison
9281a4a804
 		New tagline: 'A tool for exploring and publishing data' 2018-07-10 19:05:41 -07:00
Simon Willison
ad66c0da2b
 		Installation instructions, including docker image - closes #328 2018-06-27 22:59:58 -05:00