Metadata-Version: 2.4
Name: shulchan-aruch
Version: 0.1.2
Summary: Experimental owner-gated codex. OpenRouter drafts an entry; only the owner key can accept it.
Author: Shelleyguitar
License-Expression: MIT
Project-URL: Homepage, https://pypi.org/project/shulchan-aruch/
Keywords: shulchan-aruch,codex,lookup,experimental
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mcp<3,>=2.2
Requires-Dist: platformdirs>=4
Dynamic: license-file

# shulchan-aruch

**Experimental.** Lookup library for a personal codification of the Shulchan Aruch.

The published table is empty. `lookup` reads a local codex on the machine
where an entry was accepted. A citation with no local entry returns
`not_codified`.

Writes require the owner key. `shulchan login --owner` stores that key only
when it matches the hash shipped in this release. `shulchan login` stores an
OpenRouter API key. `shulchan work` drafts one citation through OpenRouter.
`/accept` writes the draft. `/drop` leaves the codex unchanged.

`shulchan gui` opens a local page at `http://127.0.0.1:8731/`. The page shows
the installed version, the project page, the owner, OpenRouter, and whether
`shulchan-mcp` is running. Lookup, draft, and accept use the same functions
as the command.

`shulchan-mcp` is a stdio MCP with `lookup`, `status`, `draft_entry`, and
`accept`. `draft_entry` and `accept` require the owner key.

The Eloq name of the lemma `shulchan-aruch` is `שולקאן-ארוק`.

```python
from shulchan_aruch import lookup

lookup("Orach Chaim 1")
```

Install: `pip install shulchan-aruch`

`shulchan` is a registered name for this project. The index rejected
`shulchanaruch` as too similar to this project.
