Skip to main content

Plain Language Notebooks

Project description

Plainbook: Natural Language Notebooks.

Authors:

Luca de Alfaro, dealfaro@acm.org

Overview

Plain Language Notebooks (Plainbook) allow you to create notebooks where the cells are written in natural language. The natural language is automatically converted to code via AI, and executed. The results of the execution are then displayed below the natural language cell.

In Plainbooks, natural language is the programming language. The goal of Plainbooks is to allow users to create and share notebooks in natural language, without having to write code, or understand the code that is shared with them. Actions to be performed are described in natural language, and the natural languate is retained, so users can edit it, improve it, and share it. We are building methods for verifying that the code implementation is faithful to the natural language description, so that users can trust the notebooks they receive from others.

Plain Language Notebooks have two type of cells:

  • Action cells, where the user describes in natural language the action to be performed (e.g., "Load the dataset from file data.csv and display the first 10 rows"). The system converts the description to code, executes it, and displays the results below the cell.

  • Comment cells, where the user can add comments, section headers, and so forth, using markdown syntax.

Differently from other notebook systems, Plainbooks are executed from start to end: random cell execution order, as in Jupyter notebooks, is not allowed. This ensures that the results are obtained in the same order in which a human reader would read the notebook.

This project is in an early stage of development.

Running Plainbook

plainbook path/to/notebook.nlb

(where .nlb is a Natural Language Notebook file; you can use other extensions if you wish). The file is created if it does not exist. For a list of command-lien options, do:

plainbook --help

If you want to be able to generate or check code from explanations, you need to add a Gemini API key in the settings (click on the gear icon in the top-right corner of the web interface).

Development

Run with:

python -m plainbook.main --debug

Running with the VSCode launch.json does not work, due to a VScode bug/quirk. See DEVELOP.md for development instructions, and see TODO.md for planned features.

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

plainbook-0.0.20.tar.gz (915.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

plainbook-0.0.20-py3-none-any.whl (923.7 kB view details)

Uploaded Python 3

File details

Details for the file plainbook-0.0.20.tar.gz.

File metadata

  • Download URL: plainbook-0.0.20.tar.gz
  • Upload date:
  • Size: 915.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for plainbook-0.0.20.tar.gz
Algorithm Hash digest
SHA256 50b8fcbca50d8042a51035b9da44c2bd5fcaaf42296886a3f8a0a069f39dfbe4
MD5 ee36452e98ce00da684e74ac4fd7d25d
BLAKE2b-256 8286aa3ec0832e029647a62eebe56a2106e80cfc133bdc06643c6e18e737563b

See more details on using hashes here.

File details

Details for the file plainbook-0.0.20-py3-none-any.whl.

File metadata

  • Download URL: plainbook-0.0.20-py3-none-any.whl
  • Upload date:
  • Size: 923.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for plainbook-0.0.20-py3-none-any.whl
Algorithm Hash digest
SHA256 24455795ca689d36c3d1c00f85e799e99a6baceeacc01a670c029387a5d7d4b1
MD5 71e6b770d156948352abee076b8ef265
BLAKE2b-256 f89d713cef867cd21b5e501b54bad654001f5caf4bc7aea75a290197d7268a87

See more details on using hashes here.

Supported by

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