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:

```python
def hello():
    print("Hello, 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.1.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.1-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: literati-0.0.1.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.1.tar.gz
Algorithm Hash digest
SHA256 53a8c35fba29fe7b264645eaa8f7e6d92489a190c1c195ef7ac5f6913f984b13
MD5 3ed825f5195d8c0badc62eb7e738dfb1
BLAKE2b-256 608d96d5d6b1486fb0dd7455e21a18ebaae9e44b114f00cc1443463d32a3b230

See more details on using hashes here.

File details

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

File metadata

  • Download URL: literati-0.0.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e6e6a1744d0bb87420f77bdf0711558c966177152afbdb94e8e8a32446b5e824
MD5 edf78c494b2cbd97dcea3e9e38a77cc1
BLAKE2b-256 af3d4e9286e6246154462fb99a1c37ac1a2d51723e6aec6811795b10f1fd2e5c

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