changed rpc.call and rpc.call_async to return bytes instead of python…

… objects; reworked docs

.gitignore

@@ -7,4 +7,4 @@ tags
 .s.vim
 dist/
 node_modules/
-tests/int_tst_fastapi/src
+tests/int_tst/src

Makefile

@@ -27,15 +27,15 @@ test-py%:
 test: test-py3.7 test-py3.8 test-py3.9 test-py3.10 test-py3.11 test-py3.12
 
 
-lock-int-tst-fast-api-py%:
+lock-int-tst-py%:
 	docker run --rm -it \
 		-v $$PWD:/mnt/${PROJECT} \
-		-w /mnt/${PROJECT}/tests/int_tst_fastapi \
+		-w /mnt/${PROJECT}/tests/int_tst \
 		python:$* bash -c \
 		"rm -f requirements$*.out && pip install -r requirements$*.in && pip freeze > requirements$*.out"
 
-test/int-tst-fast-api:
-	cd tests/int_tst_fastapi \
+test/int-tst:
+	cd tests/int_tst \
 		&& docker compose stop \
 		&& docker compose build \
 		&& docker compose up frontend \

ci-requirements/requirements3.10.in

@@ -1,5 +1,6 @@
 pytest
 pytest-cov
 pytest-benchmark
+pytest-asyncio
 
 pydantic

ci-requirements/requirements3.10.out

@@ -1,14 +1,15 @@
 annotated-types==0.6.0
-coverage==7.4.1
+coverage==7.4.4
 exceptiongroup==1.2.0
 iniconfig==2.0.0
-packaging==23.2
+packaging==24.0
 pluggy==1.4.0
 py-cpuinfo==9.0.0
-pydantic==2.6.1
-pydantic_core==2.16.2
-pytest==8.0.0
+pydantic==2.6.4
+pydantic_core==2.16.3
+pytest==8.1.1
+pytest-asyncio==0.23.5.post1
 pytest-benchmark==4.0.0
 pytest-cov==4.1.0
 tomli==2.0.1
-typing_extensions==4.9.0
+typing_extensions==4.10.0

ci-requirements/requirements3.11.in

@@ -1,5 +1,6 @@
 pytest
 pytest-cov
 pytest-benchmark
+pytest-asyncio
 
 pydantic

ci-requirements/requirements3.11.out

@@ -1,12 +1,13 @@
 annotated-types==0.6.0
-coverage==7.4.3
+coverage==7.4.4
 iniconfig==2.0.0
-packaging==23.2
+packaging==24.0
 pluggy==1.4.0
 py-cpuinfo==9.0.0
-pydantic==2.6.3
+pydantic==2.6.4
 pydantic_core==2.16.3
-pytest==8.0.2
+pytest==8.1.1
+pytest-asyncio==0.23.5.post1
 pytest-benchmark==4.0.0
 pytest-cov==4.1.0
 typing_extensions==4.10.0

ci-requirements/requirements3.12.in

@@ -1,5 +1,6 @@
 pytest
 pytest-cov
 pytest-benchmark
+pytest-asyncio
 
 pydantic

ci-requirements/requirements3.12.out

@@ -1,12 +1,13 @@
 annotated-types==0.6.0
-coverage==7.4.3
+coverage==7.4.4
 iniconfig==2.0.0
-packaging==23.2
+packaging==24.0
 pluggy==1.4.0
 py-cpuinfo==9.0.0
-pydantic==2.6.3
+pydantic==2.6.4
 pydantic_core==2.16.3
-pytest==8.0.2
+pytest==8.1.1
+pytest-asyncio==0.23.5.post1
 pytest-benchmark==4.0.0
 pytest-cov==4.1.0
 setuptools==69.0.3

ci-requirements/requirements3.7.in

@@ -1,5 +1,6 @@
 pytest
 pytest-cov
 pytest-benchmark
+pytest-asyncio
 
 pydantic

ci-requirements/requirements3.7.out

@@ -3,12 +3,13 @@ coverage==7.2.7
 exceptiongroup==1.2.0
 importlib-metadata==6.7.0
 iniconfig==2.0.0
-packaging==23.2
+packaging==24.0
 pluggy==1.2.0
 py-cpuinfo==9.0.0
 pydantic==2.5.3
 pydantic_core==2.14.6
 pytest==7.4.4
+pytest-asyncio==0.21.1
 pytest-benchmark==4.0.0
 pytest-cov==4.1.0
 tomli==2.0.1

ci-requirements/requirements3.8.in

@@ -1,5 +1,6 @@
 pytest
 pytest-cov
 pytest-benchmark
+pytest-asyncio
 
 pydantic

ci-requirements/requirements3.8.out

@@ -1,13 +1,14 @@
 annotated-types==0.6.0
-coverage==7.4.3
+coverage==7.4.4
 exceptiongroup==1.2.0
 iniconfig==2.0.0
-packaging==23.2
+packaging==24.0
 pluggy==1.4.0
 py-cpuinfo==9.0.0
-pydantic==2.6.3
+pydantic==2.6.4
 pydantic_core==2.16.3
-pytest==8.0.2
+pytest==8.1.1
+pytest-asyncio==0.23.5.post1
 pytest-benchmark==4.0.0
 pytest-cov==4.1.0
 tomli==2.0.1

docs/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.2.0 (2024-03-17)
+
+**Incompatible changes**
+
+- changed `rpc.call` and `rpc.call_async` to return bytes instead of python
+  dicts/lists
+
+
 ## 0.1.0
 
 Initial version.

docs/README.md

@@ -13,6 +13,7 @@ TypeScript client.
 
 ## Idea
 
+
 The below must be enough to define an API:
 
 ```python
@@ -81,8 +82,8 @@ pip install synclane
 ## Usage
 
 1. define procedures
-1. define RPC instance, its error handling method and register procedures
-1. dump TypeScript client code
+1. define RPC instance, its error handling method, register procedures and dump
+   TypeScript client code
 1. connect RPC to an API
 1. on TypeScript side: import `rpcConfig` and initialize:
      - `rpcConfig.url`: url where RPC is listening
@@ -92,18 +93,49 @@ pip install synclane
 
 ## Example
 
-/// tab | main.py
+#### Step 1: Define procedures
+
+```python
+--8<-- "tests/int_tst/main.py:def_procedures"
+```
+
+#### Step 2: Define RPC, dump TS
 
 ```python
-{!../tests/int_tst_fastapi/main.py!}
+--8<-- "tests/int_tst/main.py:def_rpc"
 ```
 
+#### Step 3.a: Connect to Django
+
+/// tab | async rpc
+```python
+--8<-- "tests/int_tst/main.py:django_async"
+```
+///
+
+/// tab | sync rpc
+```python
+--8<-- "tests/int_tst/main.py:django_sync"
+```
 ///
 
-/// tab | client.test.ts
+#### Step 3.b: Connect to FastAPI
 
-```typescript
-{!../tests/int_tst_fastapi/tests/client.test.ts!}
+/// tab | async rpc
+```python
+--8<-- "tests/int_tst/main.py:fastapi_async"
 ```
+///
 
+/// tab | async rpc
+```python
+--8<-- "tests/int_tst/main.py:fastapi_sync"
+```
 ///
+
+#### Step 4: Use autogenerated TS client
+```typescript
+--8<-- "tests/int_tst/tests/client.test.ts:imports"
+--8<-- "tests/int_tst/tests/client.test.ts:rpc_config"
+--8<-- "tests/int_tst/tests/client.test.ts:get_user"
+```

mkdocs.yml

@@ -37,3 +37,6 @@ markdown_extensions:
       use_pygments: true
   - pymdownx.inlinehilite:
   - pymdownx.superfences:
+  - pymdownx.snippets:
+      base_path: .
+      dedent_subsections: true

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "synclane"
-version = "0.1.0"
+version = "0.2.0"
 description = "framework-agnostic RPC API with a smart auto-generated TypeScript client"
 authors = [
   {email = "[email protected]", name = "Nikita Almakov"},