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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file datasette-notebook-0.1a1.tar.gz.

File metadata

  • Download URL: datasette-notebook-0.1a1.tar.gz
  • Upload date:
  • Size: 4.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for datasette-notebook-0.1a1.tar.gz
Algorithm Hash digest
SHA256 e31fb382f6bb314ced55cdb4d01eb7eb612dbfb5a0f0b72a9b076c7c5d875a29
MD5 011489ef92d28f0f538b1157d451784a
BLAKE2b-256 13cfbc9f7b18afd9c304e62e3dc7b627823195cb52b67f7e8227e6376df7bd3a

See more details on using hashes here.

File details

Details for the file datasette_notebook-0.1a1-py3-none-any.whl.

File metadata

  • Download URL: datasette_notebook-0.1a1-py3-none-any.whl
  • Upload date:
  • Size: 5.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for datasette_notebook-0.1a1-py3-none-any.whl
Algorithm Hash digest
SHA256 1650eeac3bb11adbf840faab05580aa434de659e009dd6a483204908e9558f7f
MD5 dcae2596037f6512e249d66fb8bd334a
BLAKE2b-256 72c8085b249f3f6798e1fc234863ef5e8b2a8a19befdc36ea1b25a3d3c120408

See more details on using hashes here.

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