allianceauth-graphql 0.1.1

GraphQL integration for AllianceAuth

allianceauth-graphql

GraphQL integration for AllianceAuth

Free software: GNU General Public License v3

Usage

This version is still in pre-alpha, as of v0.1.1 it does nothing.

Setup

The following is assuming you have a functioning AllianceAuth installation.

Install plugin

1. pip install allianceauth-graphql.

2. Add 'allianceauth_graphql' (note the underscore) to the bottom of your INSTALLED_APPS in the local.py settings file.

3. Add the following setting at the bottom of your urls.py file:

   GRAPHENE = {
       'SCHEMA': 'allianceauth_graphql.schema.schema',
   }
   

4. Edit your projects url.py file:

   It should look something like this

   from django.conf.urls import include, url
   from allianceauth import urls
   
   urlpatterns = [
       url(r'', include(urls)),
   ]
   
   handler500 = 'allianceauth.views.Generic500Redirect'
   handler404 = 'allianceauth.views.Generic404Redirect'
   handler403 = 'allianceauth.views.Generic403Redirect'
   handler400 = 'allianceauth.views.Generic400Redirect'
   

   After the edit:

   from django.conf.urls import include, url
   from allianceauth import urls
   from allianceauth_graphql import urls as aa_gql_urls
   
   urlpatterns = [
       url(r'', include(urls)),
       url(r'graphql/', include(aa_gql_urls)),
   ]
   
   handler500 = 'allianceauth.views.Generic500Redirect'
   handler404 = 'allianceauth.views.Generic404Redirect'
   handler403 = 'allianceauth.views.Generic403Redirect'
   handler400 = 'allianceauth.views.Generic400Redirect'
   

Settings

Setting	Default	Description
SHOW_GRAPHIQL	True	Shows the graphiql UI in the browser

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

v0.1.0 (2022-04-02)

* Working /graphql/ endpoint and updated requirements.

v0.1.0 (2022-03-18)

* First release on PyPI.