Version 6.0.0

.github/workflows/code-quality.yml

@@ -10,7 +10,7 @@ jobs:
       with:
         python-version: 3.8
     - run: pip install --upgrade pip
-    - run: pip install types-setuptools "black<23" "pylint<3" "mypy<1" "jsonschema<5" pytest "oslash<1" "aiohttp<4" "aiozmq<1" "django<5" "fastapi<1" "flask<3" "flask-socketio<5.3.1" "pyzmq" "sanic" "tornado<7" "uvicorn<1" "websockets<11"
-    - run: black --diff --check $(git ls-files -- '*.py' ':!:docs/*')
-    - run: pylint $(git ls-files -- '*.py' ':!:docs/*')
+    - run: pip install types-setuptools "black<23" ruff "mypy<2" "jsonschema<5" pytest "returns<1" "aiohttp<4" "aiozmq<1" "django<5" "fastapi<1" "flask<3" "flask-socketio<5.3.1" "pyzmq" "sanic" "tornado<7" "uvicorn<1" "websockets<11"
+    - run: ruff check --select I $(git ls-files -- '*.py' ':!:docs/*')
+    - run: ruff format --check $(git ls-files -- '*.py' ':!:docs/*')
     - run: mypy --strict $(git ls-files -- '*.py' ':!:docs/*')

.pre-commit-config.yaml

@@ -3,38 +3,24 @@ default_language_version:
 exclude: (^docs)
 fail_fast: true
 repos:
-  - repo: https://github.com/ambv/black
-    rev: 22.8.0
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.4.1
     hooks:
-      - id: black
-        args: [--diff, --check]
-
-  - repo: https://github.com/PyCQA/pylint
-    rev: v2.15.3
-    hooks:
-      - id: pylint
-        additional_dependencies:
-          - oslash<1
-          - aiohttp<4
-          - aiozmq<1
-          - django<5
-          - fastapi<1
-          - flask<3
-          - flask-socketio<5.3.1
-          - jsonschema<5
-          - pytest
-          - pyzmq
-          - sanic
-          - tornado<7
-          - uvicorn<1
-          - websockets<11
+      - id: ruff
+        name: lint with ruff
+      - id: ruff
+        name: sort imports with ruff
+        args: [--select, I, --fix]
+      - id: ruff-format
+        name: format with ruff
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.971
+    rev: v1.2.0
     hooks:
       - id: mypy
         args: [--strict]
         additional_dependencies:
+          - returns<1
           - aiohttp<4
           - aiozmq<1
           - django<5

CHANGELOG.md

@@ -1,5 +1,25 @@
 # jsonrpcserver Change Log
 
+## 6.0.0 (May 18, 2022)
+
+A small release but incrementing the major release number due to a breaking
+change for async use.
+
+Breaking changes:
+
+- Async methods should be decorated with `@async_method` instead of `@method`. The
+  reason is due to the _type_ of the decorated function - async functions have a
+  different type to other functions (`Awaitable`).
+
+Other changes:
+
+- Replaced the Oslash dependency with [Returns](https://github.com/dry-python/returns).
+  Oslash is not meant for production use, and doesn't work in Python 3.12.
+- Use `Ok` instead of `Success` when returning a response. This is to avoid confusion
+  with the Returns library's `Success` class. It also matches Jsonrpcclient's `Ok` type.
+  This is not a breaking change, `Success` will still work for now.
+- Docs moved to https://github.com/explodinglabs/jsonrpcserver/wiki
+
 ## 5.0.9 (Sep 15, 2022)
 
 - Remove unncessary `package_data` from setup.py (#243)

README.md

@@ -1,13 +1,14 @@
 <img
     alt="jsonrpcserver"
     style="margin: 0 auto;"
-    src="https://github.com/explodinglabs/jsonrpcserver/blob/main/docs/logo.png?raw=true"
+    src="https://github.com/explodinglabs/jsonrpcserver/blob/main/logo.png?raw=true"
 />
 
 ![PyPI](https://img.shields.io/pypi/v/jsonrpcserver.svg)
 ![Code Quality](https://github.com/explodinglabs/jsonrpcserver/actions/workflows/code-quality.yml/badge.svg)
 ![Coverage Status](https://coveralls.io/repos/github/explodinglabs/jsonrpcserver/badge.svg?branch=main)
 ![Downloads](https://img.shields.io/pypi/dw/jsonrpcserver)
+![License](https://img.shields.io/pypi/l/jsonrpcserver.svg)
 
 Process incoming JSON-RPC requests in Python.
 
@@ -16,24 +17,18 @@ pip install jsonrpcserver
 ```
 
 ```python
-from jsonrpcserver import method, serve, Success
+from jsonrpcserver import method, Result, Ok
 
 @method
-def ping():
-    return Success("pong")
+def ping() -> Result:
+    return Ok("pong")
 
-if __name__ == "__main__":
-    serve()
-```
-
-Or use `dispatch` instead of `serve`:
-```python
 response = dispatch('{"jsonrpc": "2.0", "method": "ping", "id": 1}')
 # => '{"jsonrpc": "2.0", "result": "pong", "id": 1}'
 ```
 
 [Watch a video on how to use it.](https://www.youtube.com/watch?v=3_BMmgJaFHQ)
 
-Full documentation is at [jsonrpcserver.com](https://www.jsonrpcserver.com/).
+Full documentation is in the [wiki](https://github.com/explodinglabs/jsonrpcserver/wiki).
 
 See also: [jsonrpcclient](https://github.com/explodinglabs/jsonrpcclient)

docs/async.md

@@ -1,13 +1,11 @@
-# Async
-
 Async dispatch is supported.
 
 ```python
-from jsonrpcserver import method, Success, async_dispatch
+from jsonrpcserver import async_dispatch, async_method, Ok, Result
 
-@method
+@async_method
 async def ping() -> Result:
-    return Success("pong")
+    return Ok("pong")
 
 await async_dispatch('{"jsonrpc": "2.0", "method": "ping", "id": 1}')
 ```