Skip to main content

datasette-endpoints

PyPI Changelog Tests License

Plugin to add a /-/endpoints debug page listing all configured endpoints

Installation

Install this plugin in the same environment as Datasette.

datasette install datasette-endpoints

Usage

Once installed, this plugin adds two endpoints to your Datasette instance:

  • /-/endpoints.json - JSON list of all registered endpoints
  • /-/endpoints - HTML page showing all registered endpoints in a table

JSON API

Visit /-/endpoints.json to get a JSON array of all registered routes:

[
    {
        "path": "/-/plugins",
        "view": "JsonDataView",
        "pattern": "/-/plugins(\\.(?P<format>json))?$"
    },
    {
        "path": "/{database}/{table}",
        "view": "TableView",
        "pattern": "/(?P<database>[^\\/\\.]+)/(?P<table>[^\\/\\.]+)(\\.(?P<format>\\w+))?$"
    }
]

Each endpoint object includes:

  • path - A simplified, human-readable URL path with {name} placeholders for URL parameters
  • view - The name of the view class or function handling the route
  • pattern - The raw regex pattern used for URL matching

HTML page

Visit /-/endpoints to see a table of all registered endpoints with their paths, view names, and regex patterns. This includes both built-in Datasette routes and any routes added by plugins.

Development

To set up this plugin locally, first checkout the code. You can confirm it is available like this:

cd datasette-endpoints
# Confirm the plugin is visible
uv run datasette plugins

To run the tests:

uv run pytest

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

datasette_endpoints-0.1.tar.gz (8.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

datasette_endpoints-0.1-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

Details for the file datasette_endpoints-0.1.tar.gz.

File metadata

  • Download URL: datasette_endpoints-0.1.tar.gz
  • Upload date:
  • Size: 8.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for datasette_endpoints-0.1.tar.gz
Algorithm Hash digest
SHA256 c0394657ed3b776f15e96d5ee210b9321c3fc03650c1561fdf521a9e4740dd88
MD5 9c6d1261702dd31faaddbad575695720
BLAKE2b-256 4d3b1df3d3257b30efee329327bf96d75b2284ae2f57384da2bc4eb8ccacf065

See more details on using hashes here.

Provenance

The following attestation bundles were made for datasette_endpoints-0.1.tar.gz:

Publisher: publish.yml on datasette/datasette-endpoints

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file datasette_endpoints-0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for datasette_endpoints-0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 688a4030599021eb06c41932a997399cd460e084a2b9d01c7639c4265526fbbc
MD5 3b7a00ccba151c07999ca95401061577
BLAKE2b-256 12c4bc117ae11e2453a912ce925e10a583e1ce4b3fcf1cfebacdc3cae832f689

See more details on using hashes here.

Provenance

The following attestation bundles were made for datasette_endpoints-0.1-py3-none-any.whl:

Publisher: publish.yml on datasette/datasette-endpoints

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.1

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page