A markdown wiki and dashboarding system for Datasette
Project description
datasette-notebook
A markdown wiki and dashboarding system for Datasette
This is an experimental alpha and everything about it is likely to change.
Installation
Install this plugin in the same environment as Datasette.
$ datasette install datasette-notebook
Usage
Start Datasette with a SQLite file called notebook.db
:
datasette notebook.db --create
Here the --create
option will create that file if it does not yet exist.
Visit /n
to create an index page. Visit /n/name
to create a page with that name.
You can link to other pages using [[WikiLink]]
syntax. This will create a link to /n/WikiLink
- spaces will be converted to underscores, and you can link to nested pages such as [[nested/page]]
.
Configuration
You can use a file other than notebook.db
by configuring it using metadata.yml
. To use a database file called otherfile.db
you would use this:
plugins:
datasette-notebook:
database: otherfile
Then start Datasette like so:
datasette otherfile.db
Development
To set up this plugin locally, first checkout the code. Then create a new virtual environment:
cd datasette-notebook
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for datasette_notebook-0.2a0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5495ba201b31baadea1a099611616fa68243b0c8597a79382da7d66a5984fd4f |
|
MD5 | d679881fce5f29a6a7172834fb1ba412 |
|
BLAKE2b-256 | d360fd17a01cb2b8fc9a6f283f87617be212d995f2fed068ee7cde1b448124e0 |