syncraft 0.2.2__py3-none-any.whl → 0.2.3__py3-none-any.whl

syncraft-0.2.3.dist-info/METADATA

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: syncraft
+Version: 0.2.3
+Summary: Parser combinator library
+Author-email: Michael Afmokt <michael@esacca.com>
+License-Expression: MIT
+Keywords: parser,combinator,sql,sqlite,generator,printer
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: rich>=14.1.0
+Requires-Dist: rstr>=3.2.2
+Requires-Dist: sqlglot>=27.7.0
+Dynamic: license-file
+
+# Syncraft
+
+Syncraft is a parser/generator combinator library for Python. It helps you
+
+- Build grammars
+- Parse SQL statement to AST
+- Search AST by grammar
+- Convert AST to dataclass
+- Check constraints over the AST/dataclass
+- Change dataclass and convert back to AST
+
+
+## Installation
+
+### pip
+```bash
+pip install syncraft
+```
+
+### uv
+```bash
+uv add syncraft
+```
+
+Python 3.10+ is required.
+
+## Quickstart
+
+!. Define grammar 
+
+```python
+from dataclasses import dataclass
+from syncraft import literal, parse, generate
+
+A = literal("a")
+B = literal("b")
+syntax = A + B  # sequence
+
+ast, _ = parse(syntax, "a b", dialect="sqlite")
+gen, _ = generate(syntax, ast)
+assert ast == gen
+```
+
+Collect parsed pieces into dataclasses using marks and `.to()`:
+
+```python
+from dataclasses import dataclass
+from syncraft import literal
+
+@dataclass
+class Pair:
+		first: any
+		second: any
+
+A = literal("a").mark("first")
+B = literal("b").mark("second")
+syntax = (A + B).to(Pair)
+
+ast, _ = parse(syntax, "a b", dialect="sqlite")
+value, invert = ast.bimap()
+# value is Pair(first=VAR(a), second=VAR(b))
+round_tripped, _ = generate(syntax, invert(value))
+assert round_tripped == ast
+```
+
+Use the built‑in SQLite grammar snippets to parse statements:
+
+```python
+from syncraft import parse
+from syncraft.sqlite3 import select_stmt
+
+ast, _ = parse(select_stmt, "select a from t where a > 1", dialect="sqlite")
+```
+
+## Core ideas
+
+- Syntax describes structure and transforms values; Algebra executes it.
+- AST types: Then, Choice, Many, Marked, Collect, Nothing, Token.
+- Operators: `+` (both), `>>` (keep right), `//` (keep left), `|` (choice), `~` (optional), `many()`, `sep_by()`, `between()`.
+- Error model supports backtracking and commit (`cut()`).
+
+## Documentation
+
+- Tutorials and API reference are built with MkDocs. Local preview:
+	1) install dev deps (see `pyproject.toml` dev group)
+	2) activate your venv and run `mkdocs serve`
+
+- Version injection: pages can use `{{ version }}`. It is provided by mkdocs-macros via `docs/main.py`, which resolves the version in this order:
+	- `[project].version` from `pyproject.toml`
+	- installed package metadata (`importlib.metadata.version('syncraft')`)
+	- fallback `"0.0.0"`
+
+  The macros plugin is configured in `mkdocs.yml` with `module_name: docs/main`.
+
+## Contributing / Roadmap
+
+- Improve performance and add benchmarks
+- Expand tutorials and SQLite coverage examples

syncraft-0.2.3.dist-info/RECORD

@@ -0,0 +1,16 @@
+syncraft/__init__.py,sha256=8LIO0m0XEAsgKd--G8u6uT-lljLDtKMeIequNRNv2dc,894
+syncraft/algebra.py,sha256=zm6HzaE2XeyhWInoKDSJrVtnkjJV6BsD0zPBRz7iDAI,23333
+syncraft/ast.py,sha256=F6aRdxZ6IBNvnk1xe_ugEBvL-BXNXdkN4s1YDIuNw3Y,19134
+syncraft/constraint.py,sha256=vJ61XwjIENpji4HxoBaNA3kqKI8oCFVwb6pNJs4Fvek,9298
+syncraft/diagnostic.py,sha256=cgwcQnCcgrCRX3h-oGTDb5rcJAtitPV3LfH9eLvO93E,2837
+syncraft/finder.py,sha256=FCOHGdJf2NHG_letl8-IArfBywEolmtZcTJQPOj1iYw,4147
+syncraft/generator.py,sha256=biTX66WzZIxKdWbkQMIj3QZzKQkRTdBeDF6oUROwp-Y,19638
+syncraft/parser.py,sha256=9z9Iq9_Ih3mlXkuz85gsND4xshZARgAqo5-R_DpgA9I,17338
+syncraft/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+syncraft/sqlite3.py,sha256=Pq09IHZOwuWg5W82l9D1flzd36QV0TOHQpTJ5U02V8g,34701
+syncraft/syntax.py,sha256=nSWE1SHvVDYON0UQM8kgp14kx54hbKBYHV0xB6fgwkk,22366
+syncraft-0.2.3.dist-info/licenses/LICENSE,sha256=wHSV424U5csa3339dy1AZbsz2xsd0hrkMx2QK48CcUk,1062
+syncraft-0.2.3.dist-info/METADATA,sha256=QwIhiVrHWAdva0s6j2x3tzOUN33-xuB0VXdsEEaP4eo,2821
+syncraft-0.2.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+syncraft-0.2.3.dist-info/top_level.txt,sha256=Kq3t8ESXB2xW1Xt3uPmkENFc-c4f2pamNmaURBk7zc8,9
+syncraft-0.2.3.dist-info/RECORD,,

syncraft-0.2.2.dist-info/METADATA

@@ -1,34 +0,0 @@
-Metadata-Version: 2.4
-Name: syncraft
-Version: 0.2.2
-Summary: Parser combinator library
-Author-email: Michael Afmokt <michael@esacca.com>
-License-Expression: MIT
-Keywords: parser,combinator,sql,sqlite,generator,printer
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: rich>=14.1.0
-Requires-Dist: rstr>=3.2.2
-Requires-Dist: sqlglot>=27.7.0
-Dynamic: license-file
-
-# Syncraft
-
-Syncraft is a parser/generator combinator library with full round-trip support:
-
-- Parse source code into AST or dataclasses
-- Generate source code from dataclasses
-- SQLite syntax support included
-
-## Installation
-
-```bash
-pip install syncraft
-```
-
-
-## TODO
-- [ ] define DSL over Variable to construct predicates
-- [ ] Try the parsing, generation, and data processing machinery on SQLite3 syntax. So that I can have direct feedback on the usability of this library and a fully functional SQLite3 library.
-- [ ] Make the library as fast as possible and feasible.

syncraft-0.2.2.dist-info/RECORD

@@ -1,16 +0,0 @@
-syncraft/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-syncraft/algebra.py,sha256=2pyxbllcRsaDS_rEXfagBenZ_etSjMNdlVYxPkoU7cQ,15849
-syncraft/ast.py,sha256=TAHj8IOgx_QtlI4zxFr2DRGZ4dwNGsb6TiH0TH9adIg,14556
-syncraft/constraint.py,sha256=4HDWXgq9ZKacKBViBxIWhbRqgZNP7cZHXOSFMyGMaaA,7274
-syncraft/diagnostic.py,sha256=cgwcQnCcgrCRX3h-oGTDb5rcJAtitPV3LfH9eLvO93E,2837
-syncraft/finder.py,sha256=Wr7wiBuO9IaXBmYBA4DNXmoeEWteRIp-UetnuRScapM,1920
-syncraft/generator.py,sha256=sa0Uyq2azFh5kW3RVsPS7aFmtR5sfBYODa5K2Fg_Jy8,13074
-syncraft/parser.py,sha256=azO1P7c2QJK_XPZtrMnK6CyTHRdlQaT9rAqfyZNtUK0,11293
-syncraft/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-syncraft/sqlite3.py,sha256=Pq09IHZOwuWg5W82l9D1flzd36QV0TOHQpTJ5U02V8g,34701
-syncraft/syntax.py,sha256=kKECtd-yIIho6DjG0fHYNpqNkJ9_zo01S7bOWUUT0VA,16294
-syncraft-0.2.2.dist-info/licenses/LICENSE,sha256=wHSV424U5csa3339dy1AZbsz2xsd0hrkMx2QK48CcUk,1062
-syncraft-0.2.2.dist-info/METADATA,sha256=VlHmCHpIuBIfamHJ6jPr6PbGCShaR0mcTE6foAtk8nI,988
-syncraft-0.2.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-syncraft-0.2.2.dist-info/top_level.txt,sha256=Kq3t8ESXB2xW1Xt3uPmkENFc-c4f2pamNmaURBk7zc8,9
-syncraft-0.2.2.dist-info/RECORD,,