Merge branch 'master' into association_proxy-support

Author: erikwrede

.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

@@ -1,6 +1,12 @@
 name: Lint
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - 'master'
+  pull_request:
+    branches:
+      - '*'
 
 jobs:
   build:

.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

@@ -7,6 +7,7 @@ on:
   pull_request:
     branches:
       - '*'
+
 jobs:
   test:
     runs-on: ubuntu-latest

README.md

@@ -18,7 +18,7 @@ A [SQLAlchemy](http://www.sqlalchemy.org/) integration for [Graphene](http://gra
 For installing Graphene, just run this command in your shell.
 
 ```bash
-pip install "graphene-sqlalchemy>=3"
+pip install --pre "graphene-sqlalchemy"
 ```
 
 ## Examples
@@ -109,11 +109,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)

README.rst

@@ -0,0 +1,18 @@
+API Reference
+==============
+
+SQLAlchemyObjectType
+--------------------
+.. autoclass:: graphene_sqlalchemy.SQLAlchemyObjectType
+
+SQLAlchemyInterface
+-------------------
+.. autoclass:: graphene_sqlalchemy.SQLAlchemyInterface
+
+ORMField
+--------------------
+.. autoclass:: graphene_sqlalchemy.types.ORMField
+
+SQLAlchemyConnectionField
+-------------------------
+.. autoclass:: graphene_sqlalchemy.SQLAlchemyConnectionField

docs/api.rst

@@ -23,7 +23,10 @@
 # import os
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
+import os
+import sys
 
+sys.path.insert(0, os.path.abspath(".."))
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
@@ -80,7 +83,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
@@ -175,7 +178,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
+# html_static_path = ["_static"]
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied

docs/conf.py

@@ -6,6 +6,10 @@ Contents:
 .. toctree::
    :maxdepth: 0
 
-   tutorial
+   starter
+   inheritance
+   relay
    tips
    examples
+   tutorial
+   api

docs/index.rst

@@ -1,9 +1,13 @@
 Inheritance Examples
 ====================
 
+
 Create interfaces from inheritance relationships
 ------------------------------------------------
-.. note:: If you're using `AsyncSession`, please check the chapter `Eager Loading & Using with AsyncSession`_.
+
+.. note::
+    If you're using `AsyncSession`, please check the chapter `Eager Loading & Using with AsyncSession`_.
+
 SQLAlchemy has excellent support for class inheritance hierarchies.
 These hierarchies can be represented in your GraphQL schema by means
 of interfaces_.  Much like ObjectTypes, Interfaces in
@@ -111,13 +115,16 @@ class to the Schema constructor via the `types=` argument:
 
 See also: `Graphene Interfaces <https://docs.graphene-python.org/en/latest/types/interfaces/>`_
 
+
 Eager Loading & Using with AsyncSession
---------------------
+----------------------------------------
+
 When querying the base type in multi-table inheritance or joined table inheritance, you can only directly refer to polymorphic fields when they are loaded eagerly.
 This restricting is in place because AsyncSessions don't allow implicit async operations such as the loads of the joined tables.
 To load the polymorphic fields eagerly, you can use the `with_polymorphic` attribute of the mapper args in the base model:
 
 .. code:: python
+
     class Person(Base):
         id = Column(Integer(), primary_key=True)
         type = Column(String())

docs/inheritance.rst

@@ -0,0 +1,43 @@
+Relay
+==========
+
+:code:`graphene-sqlalchemy` comes with pre-defined
+connection fields to quickly create a functioning relay API.
+Using the :code:`SQLAlchemyConnectionField`, you have access to relay pagination,
+sorting and filtering (filtering is coming soon!).
+
+To be used in a relay connection, your :code:`SQLAlchemyObjectType` must implement
+the :code:`Node` interface from :code:`graphene.relay`. This handles the creation of
+the :code:`Connection` and :code:`Edge` types automatically.
+
+The following example creates a relay-paginated connection:
+
+
+
+.. code:: python
+
+    class Pet(Base):
+        __tablename__ = 'pets'
+        id = Column(Integer(), primary_key=True)
+        name = Column(String(30))
+        pet_kind = Column(Enum('cat', 'dog', name='pet_kind'), nullable=False)
+
+
+    class PetNode(SQLAlchemyObjectType):
+        class Meta:
+            model = Pet
+            interfaces=(Node,)
+
+
+    class Query(ObjectType):
+        all_pets = SQLAlchemyConnectionField(PetNode.connection)
+
+To disable sorting on the connection, you can set :code:`sort` to :code:`None` the
+:code:`SQLAlchemyConnectionField`:
+
+
+.. code:: python
+
+    class Query(ObjectType):
+        all_pets = SQLAlchemyConnectionField(PetNode.connection, sort=None)
+

docs/relay.rst

@@ -1,2 +1,3 @@
+sphinx
 # Docs template
 http://graphene-python.org/sphinx_graphene_theme.zip