graphene-sqlalchemy > abc-sqlalchemy/next

.github/workflows/deploy.yml

@@ -0,0 +1,26 @@
+name: 🚀 Deploy to PyPI
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.10'
+    - name: Build wheel and source tarball
+      run: |
+        pip install wheel
+        python setup.py sdist bdist_wheel
+    - name: Publish a Python distribution to PyPI
+      uses: pypa/[email protected]
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/docs.yml

@@ -0,0 +1,19 @@
+name: Deploy Docs
+
+# Runs on pushes targeting the default branch
+on:
+  push:
+    branches: [master]
+
+jobs:
+  pages:
+    runs-on: ubuntu-22.04
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write
+      id-token: write
+    steps:
+    - id: deployment
+      uses: sphinx-notes/pages@v3

.github/workflows/lint.yml

@@ -0,0 +1,28 @@
+name: Lint
+
+on:
+  push:
+    branches:
+      - 'master'
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.10'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install tox
+    - name: Run lint 💅
+      run: tox
+      env:
+        TOXENV: flake8

.github/workflows/manage_issues.yml

@@ -0,0 +1,49 @@
+name: Issue Manager
+
+on:
+  schedule:
+    - cron: "0 0 * * *"
+  issue_comment:
+    types:
+      - created
+  issues:
+    types:
+      - labeled
+  pull_request_target:
+    types:
+      - labeled
+  workflow_dispatch:
+
+permissions:
+  issues: write
+  pull-requests: write
+
+concurrency:
+  group: lock
+
+jobs:
+  lock-old-closed-issues:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: dessant/lock-threads@v4
+        with:
+          issue-inactive-days: '180'
+          process-only: 'issues'
+          issue-comment: >
+            This issue has been automatically locked since there
+            has not been any recent activity after it was closed.
+            Please open a new issue for related topics referencing
+            this issue.
+  close-labelled-issues:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: tiangolo/[email protected]
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          config: >
+            {
+              "needs-reply": {
+                "delay": 2200000,
+                "message": "This issue was closed due to inactivity. If your request is still relevant, please open a new issue referencing this one and provide all of the requested information."
+              }
+            }

.github/workflows/tests.yml

@@ -0,0 +1,44 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - 'master'
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 10
+      matrix:
+        sql-alchemy: [ "1.2", "1.3", "1.4","2.0" ]
+        python-version: [ "3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox tox-gh-actions
+      - name: Test with tox
+        run: tox
+        env:
+          SQLALCHEMY: ${{ matrix.sql-alchemy }}
+          TOXENV: ${{ matrix.toxenv }}
+      - name: Upload coverage.xml
+        if: ${{ matrix.sql-alchemy == '1.4' && matrix.python-version == '3.10' }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: graphene-sqlalchemy-coverage
+          path: coverage.xml
+          if-no-files-found: error
+      - name: Upload coverage.xml to codecov
+        if: ${{ matrix.sql-alchemy == '1.4' && matrix.python-version == '3.10' }}
+        uses: codecov/codecov-action@v3

.gitignore

@@ -12,6 +12,7 @@ __pycache__/
 .Python
 env/
 .venv/
+venv/
 build/
 develop-eggs/
 dist/
@@ -26,6 +27,7 @@ var/
 *.egg-info/
 .installed.cfg
 *.egg
+.python-version
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
@@ -47,6 +49,7 @@ nosetests.xml
 coverage.xml
 *,cover
 .pytest_cache/
+.benchmarks/
 
 # Translations
 *.mo
@@ -67,3 +70,9 @@ target/
 # Databases
 *.sqlite3
 .vscode
+
+# Schema
+*.gql
+
+# mypy cache
+.mypy_cache/

.pre-commit-config.yaml

@@ -1,25 +1,30 @@
 default_language_version:
-    python: python3.7
+  python: python3.8
 repos:
--   repo: git://github.com/pre-commit/pre-commit-hooks
-    rev: c8bad492e1b1d65d9126dba3fe3bd49a5a52b9d6  # v2.1.0
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.2.0
     hooks:
-    -   id: check-merge-conflict
-    -   id: check-yaml
-    -   id: debug-statements
-    -   id: end-of-file-fixer
+      - id: check-merge-conflict
+      - id: check-yaml
+      - id: debug-statements
+      - id: end-of-file-fixer
         exclude: ^docs/.*$
-    -   id: trailing-whitespace
+      - id: trailing-whitespace
         exclude: README.md
--   repo: git://github.com/PyCQA/flake8
-    rev: 88caf5ac484f5c09aedc02167c59c66ff0af0068  # 3.7.7
+  - repo: https://github.com/pycqa/isort
+    rev: 5.12.0
     hooks:
-    -   id: flake8
--   repo: git://github.com/asottile/seed-isort-config
-    rev: v1.7.0
+      - id: isort
+        name: isort (python)
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v2.37.3
     hooks:
-    -   id: seed-isort-config
--   repo: git://github.com/pre-commit/mirrors-isort
-    rev: v4.3.4
+      - id: pyupgrade
+  - repo: https://github.com/psf/black
+    rev: 22.6.0
     hooks:
-    -   id: isort
+      - id: black
+  - repo: https://github.com/PyCQA/flake8
+    rev: 4.0.0
+    hooks:
+      - id: flake8

README.md

@@ -1,19 +1,24 @@
-Please read [UPGRADE-v2.0.md](https://github.com/graphql-python/graphene/blob/master/UPGRADE-v2.0.md)
-to learn how to upgrade to Graphene `2.0`.
+Version 3.0 is in beta stage. Please read https://github.com/graphql-python/graphene-sqlalchemy/issues/348 to learn about progress and changes in upcoming
+beta releases.
 
 ---
 
-# ![Graphene Logo](http://graphene-python.org/favicon.png) Graphene-SQLAlchemy [![Build Status](https://travis-ci.org/graphql-python/graphene-sqlalchemy.svg?branch=master)](https://travis-ci.org/graphql-python/graphene-sqlalchemy) [![PyPI version](https://badge.fury.io/py/graphene-sqlalchemy.svg)](https://badge.fury.io/py/graphene-sqlalchemy) [![Coverage Status](https://coveralls.io/repos/graphql-python/graphene-sqlalchemy/badge.svg?branch=master&service=github)](https://coveralls.io/github/graphql-python/graphene-sqlalchemy?branch=master)
+# ![Graphene Logo](http://graphene-python.org/favicon.png) Graphene-SQLAlchemy 
+[![Build Status](https://github.com/graphql-python/graphene-sqlalchemy/workflows/Tests/badge.svg)](https://github.com/graphql-python/graphene-sqlalchemy/actions)
+[![PyPI version](https://badge.fury.io/py/graphene-sqlalchemy.svg)](https://badge.fury.io/py/graphene-sqlalchemy) 
+![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/graphql-python/graphene-sqlalchemy?color=green&include_prereleases&label=latest)
+[![codecov](https://codecov.io/gh/graphql-python/graphene-sqlalchemy/branch/master/graph/badge.svg?token=Zi5S1TikeN)](https://codecov.io/gh/graphql-python/graphene-sqlalchemy)
+
 
 
 A [SQLAlchemy](http://www.sqlalchemy.org/) integration for [Graphene](http://graphene-python.org/).
 
 ## Installation
 
-For instaling graphene, just run this command in your shell
+For installing Graphene, just run this command in your shell.
 
 ```bash
-pip install "graphene-sqlalchemy>=2.0"
+pip install --pre "graphene-sqlalchemy"
 ```
 
 ## Examples
@@ -34,7 +39,7 @@ class UserModel(Base):
     last_name = Column(String)
 ```
 
-To create a GraphQL schema for it you simply have to write the following:
+To create a GraphQL schema for it, you simply have to write the following:
 
 ```python
 import graphene
@@ -43,10 +48,10 @@ from graphene_sqlalchemy import SQLAlchemyObjectType
 class User(SQLAlchemyObjectType):
     class Meta:
         model = UserModel
-        # only return specified fields
-        only_fields = ("name",)
-        # exclude specified fields
-        exclude_fields = ("last_name",)
+        # use `only_fields` to only expose specific fields ie "name"
+        # only_fields = ("name",)
+        # use `exclude_fields` to exclude specific fields ie "last_name"
+        # exclude_fields = ("last_name",)
 
 class Query(graphene.ObjectType):
     users = graphene.List(User)
@@ -58,6 +63,21 @@ class Query(graphene.ObjectType):
 schema = graphene.Schema(query=Query)
 ```
 
+We need a database session first:
+
+```python
+from sqlalchemy import (create_engine)
+from sqlalchemy.orm import (scoped_session, sessionmaker)
+
+engine = create_engine('sqlite:///database.sqlite3', convert_unicode=True)
+db_session = scoped_session(sessionmaker(autocommit=False,
+                                         autoflush=False,
+                                         bind=engine))
+# We will need this for querying, Graphene extracts the session from the base.
+# Alternatively it can be provided in the GraphQLResolveInfo.context dictionary under context["session"]
+Base.query = db_session.query_property()
+```
+
 Then you can simply query the schema:
 
 ```python
@@ -104,11 +124,11 @@ schema = graphene.Schema(query=Query)
 
 ### Full Examples
 
-To learn more check out the following [examples](examples/):
+To learn more check out the following [examples](https://github.com/graphql-python/graphene-sqlalchemy/tree/master/examples/):
 
-- [Flask SQLAlchemy example](examples/flask_sqlalchemy)
-- [Nameko SQLAlchemy example](examples/nameko_sqlalchemy)
+- [Flask SQLAlchemy example](https://github.com/graphql-python/graphene-sqlalchemy/tree/master/examples/flask_sqlalchemy)
+- [Nameko SQLAlchemy example](https://github.com/graphql-python/graphene-sqlalchemy/tree/master/examples/nameko_sqlalchemy)
 
 ## Contributing
 
-See [CONTRIBUTING.md](/CONTRIBUTING.md)
+See [CONTRIBUTING.md](https://github.com/graphql-python/graphene-sqlalchemy/blob/master/CONTRIBUTING.md)