improve CI and pre-commit configurations

hrana-test-server is now a submodule, to simplify execution.

Improve README.rst docs for development.

Author: barbieri

.github/workflows/ci.yml

@@ -4,7 +4,15 @@ on:
   push:
     branches: [ master ]
   pull_request:
-    branches: [ '*' ]
+    types:
+      - opened
+      - synchronize
+      - reopened
+      - ready_for_review
+
+concurrency:
+  group: ci-check-${{ github.ref }}
+  cancel-in-progress: true
 
 jobs:
   check:
@@ -15,6 +23,8 @@ jobs:
         "python-version": ["3.7", "3.11"]
     steps:
     - uses: actions/checkout@v3
+      with:
+        submodules: true
     - name: "Install Poetry"
       run: "pip install poetry"
     - name: "Setup Python"
@@ -25,10 +35,3 @@ jobs:
     - name: "Install poetry dependencies"
       run: "poetry install --no-interaction"
     - uses: pre-commit/action@v3.0.0
-    - name: "Checkout hrana-test-server"
-      uses: actions/checkout@v3
-      with:
-        repository: "libsql/hrana-test-server"
-        path: "hrana-test-server"
-    - name: "Test with server v2"
-      run: "poetry run python hrana-test-server/server_v2.py pytest --verbose"

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "hrana-test-server"]
+	path = hrana-test-server
+	url = https://github.com/libsql/hrana-test-server
+	branch =  main

.pre-commit-config.yaml

@@ -32,7 +32,8 @@ repos:
     hooks:
     -   id: pytest-check
         name: pytest-check
-        entry: pytest
+        entry: poetry run python hrana-test-server/server_v2.py pytest --verbose
         language: system
         pass_filenames: false
         always_run: true
+        types: [python]

README.rst

@@ -32,6 +32,29 @@ Then, in your Python app, you can connect to the database via::
 Note that ``secure=true`` query/search parameter will force the usage of
 secure WebSockets (``wss://``) to connect to the remote server.
 
+Development
+-----------
+
+This project uses `poetry<https://python-poetry.org/>`_, can be tested with
+`pytest<https://pytest.org/>`_ and should be checked with
+`pre-commit<https://pre-commit.com/>`_. A
+`pure-python<https://github.com/libsql/hrana-test-server>`_ test server is used
+as a submodule::
+
+    git clone https://github.com/libsql/sqlalchemy-libsql.git
+    cd sqlalchemy-libsql
+    git submodule init && git submodule update  # hrana-test-server
+
+    pre-commit install         # install git-hooks
+    poetry install --with dev  # pytest
+
+    pre-commit run -a          # check all files in the project, runs pytest
+
+    poetry run pytest
+    poetry run pytest --log-debug=libsql_client  # debug libsql_client usage
+    # run against WSS server:
+    poetry run pytest --dburi "sqlite+libsql://server.com?secure=true&authToken=JWT_HERE"
+
 
 The SQLAlchemy Project
 ======================