Skip to content

Add a README#6

Merged
christiankissig merged 1 commit into
masterfrom
add-readme
Jun 2, 2026
Merged

Add a README#6
christiankissig merged 1 commit into
masterfrom
add-readme

Conversation

@christiankissig

Copy link
Copy Markdown
Owner

Summary

README.rst was referenced as the package readme in pyproject.toml but was empty (0 bytes). This fills it in.

Contents:

  • What the project is — a pure-Python Lark/Earley parser for Isabelle/Isar outer syntax.
  • Status — work in progress; a failure means "not yet supported", not "invalid Isabelle".
  • Requirements & installation (pip install . / .[dev]).
  • CLI usagepython -m isabelle_parser.cli, including -f/--file and -t/--timeout.
  • Library APIparse(input_text, parser=None, timeout=None), load_parser(start="start"), ParsingError, with the SIGALRM/main-thread caveat for timeout.
  • Development commands and grammar location.
  • License (MIT).

Validation

  • Both the library and CLI examples in the README were run and produce the documented output.
  • RST validated clean with docutils (no warnings/errors).

🤖 Generated with Claude Code

The package referenced README.rst as its readme but the file was empty.
Document what the parser is (Lark/Earley parser for Isabelle/Isar outer
syntax), its work-in-progress status, installation, CLI usage (incl.
--timeout), the public API (parse/load_parser/ParsingError), and the dev
workflow.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@christiankissig christiankissig merged commit 5bb06bf into master Jun 2, 2026
6 checks passed
@christiankissig christiankissig deleted the add-readme branch June 2, 2026 13:36
christiankissig added a commit that referenced this pull request Jul 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant