Initial commit

Author: barbieri

.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+name: Python CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ '*' ]
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.draft != true
+    strategy:
+      matrix:
+        "python-version": ["3.7", "3.11"]
+    steps:
+    - uses: actions/checkout@v3
+    - name: "Install Poetry"
+      run: "pip install poetry"
+    - name: "Setup Python"
+      uses: actions/setup-python@v4
+      with:
+        python-version: "${{ matrix.python-version }}"
+        cache: "poetry"
+    - 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"

.gitignore

@@ -0,0 +1,8 @@
+/.eggs/
+/.idea/
+/.venv/
+/build/
+/dist/
+/test/__pycache__/
+/sqlalchemy_libsql/__pycache__/
+/sqlalchemy_libsql.egg-info/

.pre-commit-config.yaml

@@ -0,0 +1,38 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/python/black
+    rev: 22.8.0
+    hooks:
+    -   id: black
+
+-   repo: https://github.com/sqlalchemyorg/zimports
+    rev: v0.6.0
+    hooks:
+    -   id: zimports
+
+-   repo: https://github.com/pycqa/flake8
+    rev: 5.0.0
+    hooks:
+    -   id: flake8
+        additional_dependencies:
+          - flake8-import-order
+          - flake8-import-single==0.1.5
+          - flake8-builtins
+          - flake8-future-annotations>=0.0.5
+          - flake8-docstrings>=1.6.0
+          - flake8-rst-docstrings
+          # flake8-rst-docstrings dependency, leaving it here
+          # in case it requires a version pin
+          - pydocstyle
+          - pygments
+
+
+-   repo: local
+    hooks:
+    -   id: pytest-check
+        name: pytest-check
+        entry: pytest
+        language: system
+        pass_filenames: false
+        always_run: true

AUTHORS

@@ -0,0 +1,2 @@
+Douglas Montes <dmontes@chiselstrike.com>
+Gustavo Sverzut Barbieri <barbieri@profusion.mobi>

LICENSE

@@ -0,0 +1,19 @@
+Copyright 2005-2023 SQLAlchemy authors and contributors <see AUTHORS file>.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.rst

@@ -0,0 +1,71 @@
+sqlalchemy-libsql
+=================
+
+A `LibSQL<https://libsql.org/>`_ dialect for SQLAlchemy.
+
+This dialect requires SQLAlchemy 2.0 or later.
+
+
+Pre-requisites
+--------------
+
+- Running instance of https://github.com/libsql/sqld. You can easily get one at https://turso.tech/
+- Alternatively a https://github.com/libsql/hrana-test-server, a pure-python implementation
+
+Co-requisites
+-------------
+
+This dialect requires SQLAlchemy and libsql_client. They are specified as requirements so ``pip``
+will install them if they are not already in place. To install, just::
+
+    pip install sqlalchemy-libsql
+
+Getting Started
+---------------
+
+Create an URL that points to your libsql database.
+Then, in your Python app, you can connect to the database via::
+
+    from sqlalchemy import create_engine
+    engine = create_engine("sqlite+libsql://your-db.your-server.com?authToken=JWT_HERE&secure=true")
+
+Note that ``secure=true`` query/search parameter will force the usage of
+secure WebSockets (``wss://``) to connect to the remote server.
+
+
+The SQLAlchemy Project
+======================
+
+SQLAlchemy-libsql is part of the `SQLAlchemy Project <https://www.sqlalchemy.org>`_ and
+adheres to the same standards and conventions as the core project.
+
+Development / Bug reporting / Pull requests
+-------------------------------------------
+
+Please refer to the
+`SQLAlchemy Community Guide <https://www.sqlalchemy.org/develop.html>`_ for
+guidelines on coding and participating in this project.
+
+Code of Conduct
+_______________
+
+Above all, SQLAlchemy places great emphasis on polite, thoughtful, and
+constructive communication between users and developers.
+Please see our current Code of Conduct at
+`Code of Conduct <https://www.sqlalchemy.org/codeofconduct.html>`_.
+
+
+Credits
+=======
+
+This project structure is based on
+https://github.com/gordthompson/sqlalchemy-access, a project cited at
+`README.dialects.rst
+<https://github.com/sqlalchemy/sqlalchemy/blob/main/README.dialects.rst>`_.
+
+
+License
+=======
+
+SQLAlchemy-libsql is distributed under the `MIT license
+<https://opensource.org/licenses/MIT>`_.