# literati
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
Jupyter notebook combines prose with code in a notebook.
[`literati`](https://radekosmulski.github.io/literati/core.html#literati)
combines prose with code in a markdown file.
## Usage
Run
[`literati`](https://radekosmulski.github.io/literati/core.html#literati).
Create a `<file_name>.md` with your favorite editor.
Write code interwoven with markdown:
> Time for some fair dinkum mischief...
Accessing the mainframe to _compile some yarn_.
```python
def hello():
print("G'day, World!!")
```
Whenever you save your file,
[`literati`](https://radekosmulski.github.io/literati/core.html#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](https://github.com/radekosmulski/literati):
``` sh
$ pip install git+https://github.com/radekosmulski/literati.git
```
or from [pypi](https://pypi.org/project/literati/)
``` sh
$ pip install literati
```
### Install literati in Development mode
``` sh
# 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
```
Raw data
{
"_id": null,
"home_page": "https://github.com/radekosmulski/literati",
"name": "literati",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "nbdev jupyter notebook python",
"author": "Radek Osmulski",
"author_email": "rosmulski@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b5/3e/74db75222b170a54a78fa110ad26ff210da060afe4a2285d76bacfa9bedb/literati-0.0.4.tar.gz",
"platform": null,
"description": "# literati\n\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\nJupyter notebook combines prose with code in a notebook.\n[`literati`](https://radekosmulski.github.io/literati/core.html#literati)\ncombines prose with code in a markdown file.\n\n## Usage\n\nRun\n[`literati`](https://radekosmulski.github.io/literati/core.html#literati).\nCreate a `<file_name>.md` with your favorite editor.\n\nWrite code interwoven with markdown:\n\n > Time for some fair dinkum mischief...\n Accessing the mainframe to _compile some yarn_.\n ```python\n def hello():\n print(\"G'day, World!!\")\n ```\n\nWhenever you save your file,\n[`literati`](https://radekosmulski.github.io/literati/core.html#literati)\ntranscribes your file to `py/<file_name>.py` stripping all the markdown.\nOnly the code remains.\n\nRun `python py/<file_name>.py` to run your code.\n\n### Options\n\n- `literati --path /custom/path` - Monitor a different directory\n- `literati --output-dir custom_output` - Use a different output\n directory\n\n## The Why\n\nI wanted to try the following pattern of working with LLMs:\n\n- context is your code\n- when you want to make changes or additions, provide the context to\n your LLM\n- ask for modifications\n- update the context to reflect the new information\n\nContext and code, always in sync. For you and your LLM.\n\n## Installation\n\nInstall latest from the GitHub\n[repository](https://github.com/radekosmulski/literati):\n\n``` sh\n$ pip install git+https://github.com/radekosmulski/literati.git\n```\n\nor from [pypi](https://pypi.org/project/literati/)\n\n``` sh\n$ pip install literati\n```\n\n### Install literati in Development mode\n\n``` sh\n# make sure literati package is installed in development mode\n$ pip install -e .\n\n# make changes under nbs/ directory\n# ...\n\n# compile to have changes apply to literati\n$ nbdev_prepare\n```\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "Code files you and your LLM can read and your computer can run.",
"version": "0.0.4",
"project_urls": {
"Homepage": "https://github.com/radekosmulski/literati"
},
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fc52b95506b36b298d21273f0a3fef8c9c48836b1566b56a47625d9895ed24af",
"md5": "b5e571069137cb757045140327991924",
"sha256": "4168fa2607ac6962bfbe9736f6e5c369ba794b3ac677033a1176814d82a1fd98"
},
"downloads": -1,
"filename": "literati-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b5e571069137cb757045140327991924",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 8451,
"upload_time": "2025-01-16T11:10:07",
"upload_time_iso_8601": "2025-01-16T11:10:07.315786Z",
"url": "https://files.pythonhosted.org/packages/fc/52/b95506b36b298d21273f0a3fef8c9c48836b1566b56a47625d9895ed24af/literati-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b53e74db75222b170a54a78fa110ad26ff210da060afe4a2285d76bacfa9bedb",
"md5": "bba82763a054034b98c2ac93f4a901fa",
"sha256": "adc3ca64115e2f9d1f76d29f7a2fe4da687f1c1dfb77fc86b693f18f6fb4514c"
},
"downloads": -1,
"filename": "literati-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "bba82763a054034b98c2ac93f4a901fa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 9178,
"upload_time": "2025-01-16T11:10:09",
"upload_time_iso_8601": "2025-01-16T11:10:09.767538Z",
"url": "https://files.pythonhosted.org/packages/b5/3e/74db75222b170a54a78fa110ad26ff210da060afe4a2285d76bacfa9bedb/literati-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-16 11:10:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "radekosmulski",
"github_project": "literati",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "literati"
}
JSON
