Skip to main content

Plain Language Notebooks

Project description

Plainbook: Natural Language Notebooks

Plainbooks allow users to create and communicate data analysis and science using natural language.

Plainbooks are notebooks that combine instructions and results, similarly to Jupyter notebooks. The difference is that Plainbook are in natural language: the code is generated "under the hood" using AI. The use of plain language allows you to share your data analysis and science with a much wider audience, including people who do not know how to code.

Plainbook can use multiple AIs to check that the code faithfully implements the natural language description, and can include tests to further validate the notebook. When you share a notebook, the recipients can also check that the code under the hood implements the natural-language tasks. Recipients can also edit the plainbook, regenerate the code, and rerun it, just as in Jupyter notebooks.

Thus, the goal of the Plainbook project is to replicate in natural language what made Juptyter notebooks so successful: the ability to share together code and results, so that any recipient can validate and modify the notebook.

Trying Plainbook

  • 30s short video
  • 5 min Introductory video.
  • Run it on Codespaces: You can run plainbook right here on GitHub, with a trial Claude key, as follows:
    • Create a codespace (Click on Code > Codespaces in the GitHub interface).
    • Wait about 3 minutes, until after it finishes the postStartCommand.
    • Once you see the button "Open in Browser" for port 8080 on the lower right, press it.
    • The Claude key provided in the trial has a low spending limit, and might not work. You can add your own keys.

Example plainbooks:

Installation and use

You can install Plainbook with pip:

pip install plainbook

To open a plainbook (which will be created if it does not exist):

plainbook notebook.nlb

You can use any file name you like, with any extension you like.

AI API Keys. You need a Gemini or Claude API key to use Plainbook. Click on the Settings button (the gear on the top right) to see instructions on how to set them. The lead developer is spending only about $2/month on Gemini and Claude together, so the expense should be very low.

Resources

Plainbook Structure

Plainbooks consist of three types 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.

  • Test cells, where the user can write properties that should hold at certain points of the notebook to check that everything is working as expected.

Differently from standard Jupyter notebooks, Plainbooks cells are guaranteed to be executed in order, from first to last, matching the order in which humans read the cells. Plainbooks relies on a checkpointing kernel to remember the execution state after each cell, so that it can re-run a cell without having to start from the beginning.

AI Providers Plainbook is designed to work with multiple AI providers, and users can choose which provider to use for code generation and checking. The system is designed to allow users to easily switch between providers, so that users can cross-check that the implementation obtained from one provider is considered valid by another provider. This avoids over-reliance on a single class of AI models. Currently, Plainbook supports Gemini and Claude models. You will need an API key for at least one such provider to use Plainbook.

Contributors

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.1.12.tar.gz (3.2 MB view details)

Uploaded Source

Built Distribution

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

plainbook-0.1.12-py3-none-any.whl (4.7 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for plainbook-0.1.12.tar.gz
Algorithm Hash digest
SHA256 bc91d38f7cf0d19a92ddf4c372bbba1e8f01e1bf2e1750cf9fbd8c8de23eef36
MD5 1332609150690fd9e834fe80d3b2bfb9
BLAKE2b-256 9297c9685f9f0e640617aecbe512610d24b5d3fd01f0be0df87f8866afb71f94

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for plainbook-0.1.12-py3-none-any.whl
Algorithm Hash digest
SHA256 f1b5f08fed5c67f10bdeee331feb6e44f974170a2327777b362a20e588eed6dc
MD5 adc6e46cd50c92901830224299c57af1
BLAKE2b-256 ce5365bb2f7d652b10fdef16e11afb39f99777d6e99ceb4c49c7e6f0277ebd6d

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