A markdown wiki and dashboarding system for Datasette

Last update: Apr 20, 2022

Related tags

Documentation datasette-notebook

Overview

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

You might also like...

Mayan EDMS is a document management system.

Mayan EDMS is a document management system. Its main purpose is to store, introspect, and categorize files, with a strong emphasis on preserving the contextual and business information of documents. It can also OCR, preview, label, sign, send, and receive thoses files.

3 Oct 2, 2021

Software engineering course project. Secondhand trading system.

PigeonSale Software engineering course project. Secondhand trading system. Documentation API doumenatation: list of APIs Backend documentation: notes

1 Sep 1, 2022

Build AGNOS, the operating system for your comma three

agnos-builder This is the tool to build AGNOS, our Ubuntu based OS. AGNOS runs on the comma three devkit. NOTE: the edk2_tici and agnos-firmare submod

21 Dec 24, 2022

BakTst_Org is a backtesting system for quantitative transactions.

BakTst_Org 中文reademe：传送门 Introduction: BakTst_Org is a prototype of the backtesting system used for BTC quantitative trading. This readme is mainly di

18 May 8, 2021

Code for our SIGIR 2022 accepted paper : P3 Ranker: Mitigating the Gaps between Pre-training and Ranking Fine-tuning with Prompt-based Learning and Pre-finetuning

P3 Ranker Implementation for our SIGIR2022 accepted paper: P3 Ranker: Mitigating the Gaps between Pre-training and Ranking Fine-tuning with Prompt-bas

14 Jan 4, 2023

🏆 A ranked list of awesome python developer tools and libraries. Updated weekly.

Best-of Python Developer Tools 🏆 A ranked list of awesome python developer tools and libraries. Updated weekly. This curated list contains 250 awesom

646 Jan 7, 2023

ReStructuredText and Sphinx bridge to Doxygen

Breathe Packagers: PGP signing key changes for Breathe = v4.23.0. https://github.com/michaeljones/breathe/issues/591 This is an extension to reStruct

643 Dec 31, 2022

Watch a Sphinx directory and rebuild the documentation when a change is detected. Also includes a livereload enabled web server.

sphinx-autobuild Rebuild Sphinx documentation on changes, with live-reload in the browser. Installation sphinx-autobuild is available on PyPI. It can

440 Jan 6, 2023

An MkDocs plugin that simplifies configuring page titles and their order

MkDocs Awesome Pages Plugin An MkDocs plugin that simplifies configuring page titles and their order The awesome-pages plugin allows you to customize

282 Dec 28, 2022

Comments

Support WikiLinks

https://python-markdown.github.io/extensions/wikilinks/

A [[bracketed]] word is any combination of upper or lower case letters, number, dashes, underscores and spaces surrounded by double brackets. Therefore

[[Bracketed]]

would produce the following HTML:

<a href="/Bracketed/" class="wikilink">Bracketed</a>

enhancement

opened by simonw 0
Installing this in Datasette Desktop breaks the app

Because of this code: https://github.com/simonw/datasette-notebook/blob/a7d9f3b1efb3aed5657dcfe357fb9dcc01940ae7/datasette_notebook/init.py#L7-L13

There's currently no way in Datasette Desktop to fix this - you have to clear your virtual environment and restart the app from scratch (using rm -rf ~/.datasette-app).
bug

opened by simonw 0
A way to embed the results of a query in a page

This is the most interesting feature of this tool - without which it's just a very simple wiki. I want to be able to embed the results of a SQL query (or filtered table page) directly into a page of notes.
enhancement

opened by simonw 12

Releases(0.2a0)

0.2a0(Nov 2, 2021)
Now supports [[WikiLink]] syntax. #5

Adds a link to the notebook to the main Datasette menu. #6

Source code(tar.gz)
Source code(zip)
0.1a2(Nov 2, 2021)
No longer prevents Datasette from starting up if the notebook database file is missing. #4

Source code(tar.gz)
Source code(zip)
0.1a1(Sep 22, 2021)
Fix bug where templates were not correctly included in the package. #3

Source code(tar.gz)
Source code(zip)
0.1a0(Sep 22, 2021)
Initial prototype.

Source code(tar.gz)
Source code(zip)

A markdown wiki and dashboarding system for Datasette

Related tags

Overview

datasette-notebook

Installation

Usage

Configuration

Development

You might also like...

Mayan EDMS is a document management system.

Software engineering course project. Secondhand trading system.

Build AGNOS, the operating system for your comma three

BakTst_Org is a backtesting system for quantitative transactions.

Code for our SIGIR 2022 accepted paper : P3 Ranker: Mitigating the Gaps between Pre-training and Ranking Fine-tuning with Prompt-based Learning and Pre-finetuning

🏆 A ranked list of awesome python developer tools and libraries. Updated weekly.

ReStructuredText and Sphinx bridge to Doxygen

Watch a Sphinx directory and rebuild the documentation when a change is detected. Also includes a livereload enabled web server.

An MkDocs plugin that simplifies configuring page titles and their order

Comments

Support WikiLinks

Installing this in Datasette Desktop breaks the app

A way to embed the results of a query in a page

Releases(0.2a0)

0.2a0(Nov 2, 2021)

0.1a2(Nov 2, 2021)

0.1a1(Sep 22, 2021)

0.1a0(Sep 22, 2021)

Owner

Simon Willison

API spec validator and OpenAPI document generator for Python web frameworks.

Assignments from Launch X's python introduction course

🧙 A simple, typed and monad-based Result type for Python.

python wrapper for simple-icons

AiiDA plugin for the HyperQueue metascheduler.

[Unofficial] Python PEP in EPUB format

Template repo to quickly make a tested and documented GitHub action in Python with Poetry

Tutorial for STARKs with supporting code in python

A curated list of python programming language blogs

Python syntax highlighted Markdown doctest.

Pydocstringformatter - A tool to automatically format Python docstrings that tries to follow recommendations from PEP 8 and PEP 257.

CoderByte | Practice, Tutorials & Interview Preparation Solutions|

The project that powers MDN.

Data Inspector is an open-source python library that brings 15++ types of different functions to make EDA, data cleaning easier.

Always know what to expect from your data.

100 Days of Code Learning program to keep a habit of coding daily and learn things at your own pace with help from our remote community.

OpenAPI (f.k.a Swagger) Specification code generator. Supports C#, PowerShell, Go, Java, Node.js, TypeScript, Python

Żmija is a simple universal code generation tool.

Rust Markdown Parsing Benchmarks

The sarge package provides a wrapper for subprocess which provides command pipeline functionality.