datasette-comments 0.1.0

A Datasette plugin for commenting on tables, rows, and values

datasette-comments

A Datasette plugin for commenting on tables, rows, and values. Work in progress, not ready yet!

Installation

Install this plugin in the same environment as Datasette.

datasette install datasette-comments

Usage

Once installed, users with the datasette-comments-access will be able to view and add comments on rows within their Datasette instance.

Plugin hooks

This plugin provies the following plugin hook which can be used to customize its behavior:

datasette_comments_users(datasette)

This hook should return a list of dictionaries, each representing a user that should be made available to the plugin. Each dictionary should have the following keys:

• id: A unique ID of the user, same as the actor ID.
• username: A unique string that is used in searches and @ mentions.
• name: A string of the user's natural name.
• profile_photo_url: Optional URL to the user's profile pic.
• email: Optional email used for gravatar profile photo, if enabled.

The plugin hook can return a list, or it can return an awaitable function that returns a list.

Development

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

cd datasette-comments
python3 -m venv venv
source venv/bin/activate

Now install the dependencies and test dependencies:

pip install -e '.[test]'

And for the JavaScript dependencies (needed to run a JavaScript build):

npm install

To run the tests:

pytest

To rebuild the minified JavaScript after making a change to a .ts or .tsx file:

just js