Skip to main content

A markdown wiki and dashboarding system for Datasette

Project description

datasette-notebook

PyPI Changelog Tests License

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

With this plugin you must either run Datasette with a file called notebook.db:

datasette notebook.db --create

Here the --create option will create that file if it does not yet exist.

Or you can use some other file name and configure that using metadata.yml:

plugins:
  datasette-notebook:
    database: otherfile

Then run Datasette with otherfile.db.

Visit /n to create an index page. Visit /n/name to create a page with that name.

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


Download files

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

Source Distribution

datasette-notebook-0.1a1.tar.gz (4.2 kB view hashes)

Uploaded Source

Built Distribution

datasette_notebook-0.1a1-py3-none-any.whl (5.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page