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.3.tar.gz (9.1 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.3-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: literati-0.0.3.tar.gz
  • Upload date:
  • Size: 9.1 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.3.tar.gz
Algorithm Hash digest
SHA256 dd447784c4793a1e14f1b559aa4d75114bf5323d01bfc117748be21dce09304a
MD5 e88c7610ca8bab4b803c222ad08c3642
BLAKE2b-256 1f06aa98e81ceaf747edaed4a23a8a8366dd23a2537a53ef235989d8c7fbaf0d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: literati-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 8.4 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 0cc7b4d599f9354f9d0ddfcf74dd7e92419b50c307184fd32208df11c8b0beff
MD5 c9ced97452fd655e5b0be5ba92fb569a
BLAKE2b-256 815d5d033f4761e289f2e906b3d606cc91702dc3ee5d035843348dd71222b5f1

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