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
1 maintainer
Metadata
1 maintainer
Release files for datasette-comments 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| datasette-comments-0.1.0.tar.gz | 47.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| datasette_comments-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 101.4 kB
Release files / datasette-comments-0.1.0.tar.gz
| Download URL | datasette-comments-0.1.0.tar.gz |
|---|---|
| Size | 47.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5b29abdb2bb9b115fae4f68c0d84560213ba63682dc6711fc571a86b0ee9cbfb
|
|
BLAKE2b-256 checksum How to use checksums |
b3f54cbf49ac7556f4b0590f77edcf273cd36de45ae1231157ceddea2fe23644
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.6
|
Release files / datasette_comments-0.1.0-py3-none-any.whl
| Download URL | datasette_comments-0.1.0-py3-none-any.whl |
|---|---|
| Size | 53.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d740f93c66dd50c3b6e1bf5bc3ae1518dea1f4a57a1c780ff669bf5e328b9da5
|
|
BLAKE2b-256 checksum How to use checksums |
e74ed6163b8d5918fbd98286260efbfc09ac02b44b6313570a4d113b783ef489
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.6
|
