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.1a0.tar.gz (3.6 kB view details)

Uploaded Source

Built Distribution

datasette_notebook-0.1a0-py3-none-any.whl (4.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: datasette-notebook-0.1a0.tar.gz
  • Upload date:
  • Size: 3.6 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.1a0.tar.gz
Algorithm Hash digest
SHA256 a4f6017019d525ca63b31c3a19f7542d44846440ad5d8710ccb8ac94385b52d3
MD5 c6b3356dc5d6acafeaa2eb1dded33aa2
BLAKE2b-256 6404609e434279d78ee88641d0b851c7723895092b638500bb09198a0f4e0da0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: datasette_notebook-0.1a0-py3-none-any.whl
  • Upload date:
  • Size: 4.0 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.1a0-py3-none-any.whl
Algorithm Hash digest
SHA256 f2d13b1a8a9b6407e6336eee0df0356de0859285387427a04041ba56d00f33a2
MD5 5cd1558bde4080ba1faa7496f8b5a06d
BLAKE2b-256 479b29adcafa963cd203dcc65f281f14e77a323eab893beafce5ef78f63b0c0f

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