Metadata-Version: 2.4
Name: nobe-literate
Version: 0.1.4
Summary: A literate programming tool for publishing html documents as a library
Project-URL: repository, https://github.com/pietroppeter/nobe
Project-URL: issue-tracker, https://github.com/pietroppeter/nobe/issues
Author: Pietro Peterlongo
License-Expression: MIT
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Requires-Dist: markdown>=3.7
Requires-Dist: pydantic>=2.10.6
Description-Content-Type: text/markdown

# nobe

Nobe (short for [nota bene](https://en.wikipedia.org/wiki/Nota_bene))
is a literate programming tool to publish html documents from python code.

Install it (`pip install` or `uv add`) as [nobe-literate](https://pypi.org/project/nobe-literate/), import it as `nobe`.

You put your code in a file like [docs/example.py](docs/example.py),
you run it like a normal python script (e.g. `uv run python example.py`)
and you get out [example.html](https://pietroppeter.github.io/nobe/example.html).

One way to try this out is:

```
curl -O https://raw.githubusercontent.com/pietroppeter/nobe/refs/heads/main/docs/example.py
uv run --with nobe-literate example.py
open example.html
```

It starts as [nimib.py] without [nim] but the goal is to experiment freely with a [nimib]-like python api.

[nimib]: https://github.com/pietroppeter/nimib
[nimib.py]: https://github.com/nimib-land/nimib.py
[nim]: https://nim-lang.org/
