Skip to main content

Code files you and your LLM can read and your computer can run.

Project description

literati

Jupyter notebook combines prose with code in a notebook. literati combines prose with code in a markdown file.

Usage

Run literati. Create a <file_name>.md with your favorite editor.

Write code interwoven with markdown:

Accessing the mainframe to compile some yarn.
```python
def hello():
    print("G'day, World!!")
```

Whenever you save your file, literati transcribes your file to py/<file_name>.py stripping all the markdown. Only the code remains.

Run python py/<file_name>.py to run your code.

Options

  • literati --path /custom/path - Monitor a different directory
  • literati --output-dir custom_output - Use a different output directory

The Why

I wanted to try the following pattern of working with LLMs:

  • context is your code
  • when you want to make changes or additions, provide the context to your LLM
  • ask for modifications
  • update the context to reflect the new information

Context and code, always in sync. For you and your LLM.

Installation

Install latest from the GitHub repository:

$ pip install git+https://github.com/radekosmulski/literati.git

or from pypi

$ pip install literati

Install literati in Development mode

# make sure literati package is installed in development mode
$ pip install -e .

# make changes under nbs/ directory
# ...

# compile to have changes apply to literati
$ nbdev_prepare

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

literati-0.0.2.tar.gz (8.9 kB view details)

Uploaded Source

Built Distribution

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

literati-0.0.2-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file literati-0.0.2.tar.gz.

File metadata

  • Download URL: literati-0.0.2.tar.gz
  • Upload date:
  • Size: 8.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for literati-0.0.2.tar.gz
Algorithm Hash digest
SHA256 9c5689a9fbfec387c1c28b142efdfbecbb81fccb047415e612316de1b3040c25
MD5 d38dfef04f707f8d9d91072396620e0b
BLAKE2b-256 60c4f677625882e25c7d376a3bc5c59e817f904885fac993c84d5478da45cd9c

See more details on using hashes here.

File details

Details for the file literati-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: literati-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for literati-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2946dcae310917121844d3014fde35e49384a91f484e65b465017788ada69785
MD5 d84e44b656531cb0867e0df82b4e4a97
BLAKE2b-256 577caa5e53620eeac89162bb9aa8ac04cc6580d7d07989db8142cf693a6f2538

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