chore: implement python stub codegen (#100)

.github/actions/publish-python/action.yml

@@ -0,0 +1,36 @@
+name: "Publish python"
+description: 'Publishes python package to PyPI'
+inputs:
+  registry-token:
+    description: token to authenticate to pypi
+    required: false
+  mode:
+    description: supported values are 'release' and 'dry-run'
+    required: true
+
+runs:
+  using: 'composite'
+  steps: 
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.10"
+
+    - name: Install Poetry
+      run: pip install --no-input poetry
+
+    - name: Publish dry run
+      if: inputs.mode == 'dry-run'
+      working-directory: codegen/python
+      shell: bash
+      run: |
+        poetry publish --build --dry-run
+    
+    - name: Publish to PyPI
+      if: inputs.mode == 'release'
+      working-directory: codegen/python
+      shell: bash
+      run: |
+        poetry config pypi-token.pypi "{% raw %}${{ inputs.registry-token }}{% endraw %}"
+        poetry publish --build

.github/workflows/generate.yml

@@ -64,6 +64,9 @@ jobs:
       - name: Generate code
         run: buf generate proto
 
+      - name: Fix python imports
+        run: find gen/python/utxorpc_spec -type f -exec sed -i '' 's@from utxorpc@from utxorpc_spec.utxorpc@g' {} \;
+
       - name: Create codegen artifact
         uses: actions/upload-artifact@v4
         with:

.github/workflows/publish-all.yml

@@ -26,6 +26,23 @@ jobs:
           registry-token: ${{ secrets.CARGO_REGISTRY_TOKEN }}
           mode: ${{ inputs.mode }}
 
+  publish-python:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: codegen
+          path: ./codegen
+
+      - uses: ./.github/actions/publish-python
+        with:
+          registry-token: ${{ secrets.PYPI_REGISTRY_TOKEN }}
+          mode: ${{ inputs.mode }}
+
   publish-node:
     runs-on: ubuntu-latest
 

.gitignore

@@ -9,3 +9,5 @@ gen/node/src/
 gen/openapi/
 gen/rust/src
 !gen/rust/src/lib.rs
+gen/python/utxorpc_spec
+gen/python/dist

Makefile

@@ -3,3 +3,4 @@
 
 all:
 	buf generate proto
+	find gen/python/utxorpc_spec -type f -exec sed -i '' 's@from utxorpc@from utxorpc_spec.utxorpc@g' {} \;

buf.gen.yaml

@@ -13,12 +13,12 @@ plugins:
     out: gen/go
     opt:
      - paths=source_relative
-  
+
   - plugin: buf.build/connectrpc/go
     out: gen/go
     opt:
      - paths=source_relative
-  
+
   # rust
 
   - plugin: prost
@@ -45,13 +45,24 @@ plugins:
       - compile_well_known_types
       - extern_path=.google.protobuf=::pbjson_types
 
+  # python
+
+  - plugin: buf.build/protocolbuffers/python
+    out: gen/python/utxorpc_spec
+
+  - plugin: buf.build/protocolbuffers/pyi
+    out: gen/python/utxorpc_spec
+
+  - plugin: buf.build/grpc/python:v1.64.2
+    out: gen/python/utxorpc_spec
+
   # node
 
   - plugin: es
     out: gen/node/src
     opt:
       - target=ts
-  
+
   - plugin: connect-es
     out: gen/node/src
     opt:

gen/python/README.md

@@ -0,0 +1,3 @@
+# UTxO RPC
+
+Auto-generated structs for the UTxO RPC spec.

gen/python/pyproject.toml

@@ -0,0 +1,23 @@
+[build-system]  # https://python-poetry.org/docs/pyproject/#poetry-and-pep-517
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]  # https://python-poetry.org/docs/pyproject/
+name = "utxorpc-spec"
+version = "0.5.1"
+description = "Auto-generated structs for the UTxO RPC spec."
+authors = ["Felipe Gonzalez <[email protected]>"]
+readme = "README.md"
+repository = "https://github.com/utxorpc/spec"
+
+# Needed because Poetry ignores whatever is on .gitignore
+include = ["utxorpc_spec/**/*.py", "utxorpc_spec/**/*.pyi"]
+
+[tool.poetry.dependencies]  # https://python-poetry.org/docs/dependency-specification/
+python = ">=3.8,<4.0"
+grpcio = "^1.64.1"
+protobuf = "^5.27.1"
+grpc-stubs = "^1.53.0.5"
+
+[[tool.poetry.source]]
+name = "pypi"