https://github.com/simonw/datasette-pretty-traces

Prettier formatting for ?_trace=1 traces
https://github.com/simonw/datasette-pretty-traces

datasette datasette-io datasette-plugin

Last synced: 27 days ago
JSON representation

Prettier formatting for ?_trace=1 traces

• Host: GitHub
• URL: https://github.com/simonw/datasette-pretty-traces
• Owner: simonw
• License: apache-2.0
• Created: 2021-12-13T19:43:28.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-08-21T19:31:00.000Z (3 months ago)
• Last Synced: 2024-10-06T20:19:35.475Z (about 1 month ago)
• Topics: datasette, datasette-io, datasette-plugin
• Language: JavaScript
• Homepage:
• Size: 19.5 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# datasette-pretty-traces

[![PyPI](https://img.shields.io/pypi/v/datasette-pretty-traces.svg)](https://pypi.org/project/datasette-pretty-traces/)

[![Changelog](https://img.shields.io/github/v/release/simonw/datasette-pretty-traces?include_prereleases&label=changelog)](https://github.com/simonw/datasette-pretty-traces/releases)

[![Tests](https://github.com/simonw/datasette-pretty-traces/workflows/Test/badge.svg)](https://github.com/simonw/datasette-pretty-traces/actions?query=workflow%3ATest)

[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/datasette-pretty-traces/blob/main/LICENSE)

Prettier formatting for `?_trace=1` traces

## Installation

Install this plugin in the same environment as Datasette.

    $ datasette install datasette-pretty-traces

## Usage

Once installed, run Datasette using `--setting trace_debug 1`:

    datasette fixtures.db --setting trace_debug 1

Then navigate to any page and add `?_trace=` to the URL:

    http://localhost:8001/?_trace=1

The plugin will scroll you down the page to the visualized trace information.

## Demo

You can try out the demo here:

- [/?_trace=1](https://latest-with-plugins.datasette.io/?_trace=1) tracing the homepage

- [/github/commits?_trace=1](https://latest-with-plugins.datasette.io/github/commits?_trace=1) tracing a table page

## Screenshot

![Screenshot showing the visualization produced by the plugin](https://user-images.githubusercontent.com/9599/145883732-a53accdd-5feb-4629-94cd-f73407c7943d.png)

## Development

To set up this plugin locally, first checkout the code. Then create a new virtual environment:

    cd datasette-pretty-traces

    python3 -mvenv venv

    source venv/bin/activate

Or if you are using `pipenv`:

    pipenv shell

Now install the dependencies and test dependencies:

    pip install -e '.[test]'

To run the tests:

    pytest