Move SDKs (#198)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Author: comnik

.github/workflows/ci.yml

@@ -24,7 +24,7 @@ jobs:
 
     - name: Lint
       run: |
-        cd python-tools
+        cd sdks/python
         uv run ruff check
         uv run ruff format --check
 
@@ -46,12 +46,12 @@ jobs:
 
     - name: Run tests
       run: |
-        cd python-tools
+        cd sdks/python
         uv run python -m pytest
 
     - name: Type check
       run: |
-        cd python-tools
+        cd sdks/python
         uv run pyrefly check
 
   julia-test:
@@ -71,7 +71,7 @@ jobs:
 
     - name: Run tests
       run: |
-        cd julia/LogicalQueryProtocol
+        cd sdks/julia/LogicalQueryProtocol
         julia --project=. -e 'using Pkg; Pkg.instantiate(); Pkg.test()'
 
   go-test:
@@ -91,5 +91,5 @@ jobs:
 
     - name: Run tests
       run: |
-        cd go
+        cd sdks/go
         go test -v ./test/print_test.go

.github/workflows/publish-python.yml

@@ -21,14 +21,14 @@ jobs:
 
     - name: Build package
       run: |
-        cd python-tools
+        cd sdks/python
         uv run python -m build
 
     - name: Upload build artifacts
       uses: actions/upload-artifact@v4
       with:
         name: dist
-        path: python-tools/dist/
+        path: sdks/python/dist/
 
   publish:
     needs: build

.gitignore

@@ -9,15 +9,15 @@ meta/src/*.egg-info/
 .venv
 .pytest_cache
 __pycache__/
-python-tools/dist/
-python-tools/build/
-python-tools/src/*.egg-info/
-python-tools/out/
-python-tools/.lsp/.cache
-python-tools/.clj-kondo
+sdks/python/dist/
+sdks/python/build/
+sdks/python/src/*.egg-info/
+sdks/python/out/
+sdks/python/.lsp/.cache
+sdks/python/.clj-kondo
 
 # Julia SDK
-julia/LogicalQueryProtocol/Manifest.toml
+sdks/julia/LogicalQueryProtocol/Manifest.toml
 
 # Other
 .DS_Store

Makefile

@@ -29,17 +29,17 @@ PROTO_FILES := \
 GRAMMAR := meta/src/meta/grammar.y
 
 # Generated protobuf outputs
-PY_PROTO_DIR := python-tools/src/lqp/proto/v1
-JL_PROTO_DIR := julia/LogicalQueryProtocol/src/gen/relationalai/lqp/v1
-GO_PROTO_DIR := go/src/lqp/v1
+PY_PROTO_DIR := sdks/python/src/lqp/proto/v1
+JL_PROTO_DIR := sdks/julia/LogicalQueryProtocol/src/gen/relationalai/lqp/v1
+GO_PROTO_DIR := sdks/go/src/lqp/v1
 
 # Generated parser outputs
-PY_PARSER := python-tools/src/lqp/gen/parser.py
-JL_PARSER := julia/LogicalQueryProtocol/src/parser.jl
-GO_PARSER := go/src/parser.go
+PY_PARSER := sdks/python/src/lqp/gen/parser.py
+JL_PARSER := sdks/julia/LogicalQueryProtocol/src/parser.jl
+GO_PARSER := sdks/go/src/parser.go
 
 # Generated printer outputs
-PY_PRINTER := python-tools/src/lqp/gen/pretty.py
+PY_PRINTER := sdks/python/src/lqp/gen/pretty.py
 
 # Parser templates
 PY_TEMPLATE := meta/src/meta/templates/parser.py.template
@@ -79,7 +79,7 @@ JL_PROTO_GENERATED := \
 
 all: protobuf parsers printers
 
-# ---------- protobuf build (replaces ./build script) ----------
+# ---------- protobuf build ----------
 
 protobuf: $(PY_PROTO_GENERATED) $(GO_PROTO_GENERATED) $(JL_PROTO_GENERATED)
 
@@ -106,73 +106,73 @@ $(PY_PROTO_GENERATED) $(GO_PROTO_GENERATED): $(PROTO_FILES)
 $(JL_PROTO_GENERATED): $(PROTO_FILES)
 	buf lint
 	buf breaking --against ".git#branch=main,subdir=proto"
-	cd julia && julia --project=LogicalQueryProtocol generate_proto.jl
+	cd sdks/julia && julia --project=LogicalQueryProtocol generate_proto.jl
 
 # ---------- parser generation ----------
 
 parsers: parser-python parser-julia parser-go
 
 parser-python: $(PY_PARSER)
 $(PY_PARSER): $(PROTO_FILES) $(GRAMMAR) $(PY_TEMPLATE)
-	$(META_CLI) $(META_PROTO_ARGS) --parser python -o ../python-tools/src/lqp/gen/parser.py
+	$(META_CLI) $(META_PROTO_ARGS) --parser python -o ../sdks/python/src/lqp/gen/parser.py
 
 parser-julia: $(JL_PARSER)
 $(JL_PARSER): $(PROTO_FILES) $(GRAMMAR) $(JL_TEMPLATE)
-	$(META_CLI) $(META_PROTO_ARGS) --parser julia -o ../julia/LogicalQueryProtocol/src/parser.jl
+	$(META_CLI) $(META_PROTO_ARGS) --parser julia -o ../sdks/julia/LogicalQueryProtocol/src/parser.jl
 
 parser-go: $(GO_PARSER)
 $(GO_PARSER): $(PROTO_FILES) $(GRAMMAR) $(GO_TEMPLATE)
-	$(META_CLI) $(META_PROTO_ARGS) --parser go -o ../go/src/parser.go
+	$(META_CLI) $(META_PROTO_ARGS) --parser go -o ../sdks/go/src/parser.go
 
 force-parsers: force-parser-python force-parser-julia force-parser-go
 
 force-parser-python:
-	$(META_CLI) $(META_PROTO_ARGS) --parser python -o ../python-tools/src/lqp/gen/parser.py
+	$(META_CLI) $(META_PROTO_ARGS) --parser python -o ../sdks/python/src/lqp/gen/parser.py
 
 force-parser-julia:
-	$(META_CLI) $(META_PROTO_ARGS) --parser julia -o ../julia/LogicalQueryProtocol/src/parser.jl
+	$(META_CLI) $(META_PROTO_ARGS) --parser julia -o ../sdks/julia/LogicalQueryProtocol/src/parser.jl
 
 force-parser-go:
-	$(META_CLI) $(META_PROTO_ARGS) --parser go -o ../go/src/parser.go
+	$(META_CLI) $(META_PROTO_ARGS) --parser go -o ../sdks/go/src/parser.go
 
 # ---------- printer generation ----------
 
 printers: printer-python
 
 printer-python: $(PY_PRINTER)
 $(PY_PRINTER): $(PROTO_FILES) $(GRAMMAR) $(PY_PRINTER_TEMPLATE)
-	$(META_CLI) $(META_PROTO_ARGS) --printer python -o ../python-tools/src/lqp/gen/pretty.py
+	$(META_CLI) $(META_PROTO_ARGS) --printer python -o ../sdks/python/src/lqp/gen/pretty.py
 
 force-printers: force-printer-python
 
 force-printer-python:
-	$(META_CLI) $(META_PROTO_ARGS) --printer python -o ../python-tools/src/lqp/gen/pretty.py
+	$(META_CLI) $(META_PROTO_ARGS) --printer python -o ../sdks/python/src/lqp/gen/pretty.py
 
 # ---------- testing ----------
 
 test: test-meta test-python test-julia test-go
 
 test-python: $(PY_PARSER) $(PY_PROTO_GENERATED) check-python
-	cd python-tools && uv run python -m pytest
+	cd sdks/python && uv run python -m pytest
 
 test-python-update-snapshots: $(PY_PARSER) $(PY_PROTO_GENERATED)
-	cd python-tools && uv run python -m pytest --snapshot-update
+	cd sdks/python && uv run python -m pytest --snapshot-update
 
 test-julia: $(JL_PARSER) $(JL_PROTO_GENERATED)
-	cd julia && julia --project=LogicalQueryProtocol -e 'using Pkg; Pkg.test()'
+	cd sdks/julia && julia --project=LogicalQueryProtocol -e 'using Pkg; Pkg.test()'
 
 test-go: $(GO_PARSER) $(GO_PROTO_GENERATED)
-	cd go && go test ./test/...
+	cd sdks/go && go test ./test/...
 
 check-python: lint-python
-	cd python-tools && uv run pyrefly check
+	cd sdks/python && uv run pyrefly check
 
 lint-python:
-	cd python-tools && uv run ruff check
-	cd python-tools && uv run ruff format --check
+	cd sdks/python && uv run ruff check
+	cd sdks/python && uv run ruff format --check
 
 format-python:
-	cd python-tools && uv run ruff format
+	cd sdks/python && uv run ruff format
 
 test-meta: check-meta
 	cd meta && uv run python -m pytest

README.md

@@ -31,28 +31,22 @@ lockstep, so compatibility in both directions is key. The vast majority of proto
 should be extensions. Existing messages can only be changed or removed when we can guarantee
 that they are no longer in use by existing clients in the wild. 
 
-In order to validate your changes and check for compatibility issues such as accidental
-reuse of field numbers, run
+In order to regenerate the ProtoBuf code for each of the three first-class languages, run:
 
 ```
-make protobuf-lint
+make protobuf
 ```
 
-Please refer to the [buf
+This will also validate your changes and check for compatibility issues such as accidental
+reuse of field numbers. Please refer to the [buf
 documentation](https://buf.build/docs/cli/quickstart/#detect-breaking-changes) to understand
 any warnings that this check may produce.
 
-To regenerate the ProtoBuf code for each of the three first-class languages, run
-
-```
-make protobuf
-```
-
 Check in your changes and then move on to updating the SDKs.
 
 ### Adding tests
 
-Protocol extensions should be covered by tests, which are all located in `test/`. Just add
+Protocol extensions should be covered by tests, which are all located in `tests/`. Just add
 new `.lqp` files that make use of the new construct you are introducing. To run the tests:
 
 ```
@@ -80,11 +74,17 @@ The code generators are implemented in `meta/`.
 
 Releasing a new version of the LQP is done by releasing new versions of each of the SDKs.
 
-This package is [deployed to PyPI](https://pypi.org/project/lqp/). For maintainers, these
-are the steps to deploy a new version:
+The Python SDK is [deployed to PyPI](https://pypi.org/project/lqp/). Publishing is automated
+via GitHub Actions: creating a GitHub release triggers a workflow that builds and uploads the
+package to PyPI. To release a new version:
+
+1. Update the version in `sdks/python/pyproject.toml`
+2. Create a new GitHub release
 
-1. `cd` into python-tools in the LQP repo
-2. Make sure the `dist` directory is empty if it exists
-3. `python -m build`
-4. `python -m twine upload dist/*`
-   * You will need to enter your API token for PyPi
+To publish manually instead:
+
+```bash
+cd sdks/python
+uv run python -m build
+uv run twine upload dist/*
+```

build

@@ -2,7 +2,7 @@
 //
 // Generated from protobuf specifications.
 // Do not modify this file! If you need to modify the parser, edit the generator code
-// in `python-tools/src/meta` or edit the protobuf specification in `proto/v1`.
+// in `meta/` or edit the protobuf specification in `proto/v1`.
 //
 // {command_line_comment}
 

meta/src/meta/templates/parser.go.template

@@ -3,7 +3,7 @@ Auto-generated LL(k) recursive-descent parser.
 
 Generated from protobuf specifications.
 Do not modify this file! If you need to modify the parser, edit the generator code
-in `python-tools/src/meta` or edit the protobuf specification in `proto/v1`.
+in `meta/` or edit the protobuf specification in `proto/v1`.
 
 {command_line_comment}"""
 

meta/src/meta/templates/parser.jl.template

@@ -3,7 +3,7 @@ Auto-generated LL(k) recursive-descent parser.
 
 Generated from protobuf specifications.
 Do not modify this file! If you need to modify the parser, edit the generator code
-in `python-tools/src/meta` or edit the protobuf specification in `proto/v1`.
+in `meta/` or edit the protobuf specification in `proto/v1`.
 
 {command_line_comment}"""
 

meta/src/meta/templates/parser.py.template

@@ -3,7 +3,7 @@ Auto-generated pretty printer.
 
 Generated from protobuf specifications.
 Do not modify this file! If you need to modify the pretty printer, edit the generator code
-in `python-tools/src/meta` or edit the protobuf specification in `proto/v1`.
+in `meta/` or edit the protobuf specification in `proto/v1`.
 
 {command_line_comment}"""