Strawberry-based GraphQL API Server for AiiDA
Project description
aiida-graphql
Strawberry-based GraphQL Server for AiiDA
Why GraphQL when there is already the REST API? See https://www.howtographql.com/basics/1-graphql-is-the-better-rest/ ... a lot of possible optimizations and fits the graph-based structure of the AiiDA DB a lot better than a REST API.
Requirements
- Python 3.7+
- https://pypi.org/project/strawberry-graphql/ 0.16.7+
- https://pypi.org/project/aiida-core/ 1.0.0b6+
For development: https://poetry.eustace.io/
Why Strawberry for GraphQL? It uses graphql-core v3 (while graphene is still stuck with v2), uses typings and dataclasses for both validation and schema generation. And it uses modern Python to write the schema, in comparison to the schema-first approach.
Why Python 3.7+? It's the future, and for Strawberry. In fact, were it not for a bug in uvloop
this would be Python 3.8+ (for the walrus operator). And given the timeline these projects are running for, we'll probably see Python 3.9 until people effectively start using it.
Why Poetry? I wanted to get away from setuptools
and used Poetry already in a different project and liked the virtualenv integration.
Usage
Development
Installing the dependencies:
git clone https://github.com/dev-zero/aiida-graphql.git
cd aiida-graphql
# for poetry installation use the official documentation
poetry install
To run the development server:
$ poetry run strawberry server aiida_graphql.schema
then visit http://localhost:8000/graphql with your browser.
Example query:
{
computers {
uuid
name
description
schedulerType
transportType
}
}
Available fields
- node
- calculation
- computer
- user
- singlefile
- gaussian_basissets (only if the aiida-gaussian-datatypes is installed)
Documentation and schema are embedded in the development server.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file aiida-graphql-0.0.2.tar.gz
.
File metadata
- Download URL: aiida-graphql-0.0.2.tar.gz
- Upload date:
- Size: 5.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.0.0b3 CPython/3.7.1 Linux/4.15.0-1040-gcp
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2c6afdee46a2b824c58647c041232798e13855adff30e15146c58f6080f1f6df |
|
MD5 | eaa8e94d8d10d9a390347a3ba0fe2e36 |
|
BLAKE2b-256 | 264b0064249862ba73186a6414e3295aa1d989e423bcb07085dcdc4be89994d7 |
File details
Details for the file aiida_graphql-0.0.2-py3-none-any.whl
.
File metadata
- Download URL: aiida_graphql-0.0.2-py3-none-any.whl
- Upload date:
- Size: 6.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.0.0b3 CPython/3.7.1 Linux/4.15.0-1040-gcp
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | fd2993827f5742014f48a6fa2dab18d9f123df85ac05059f00e0a1be1e45eb8a |
|
MD5 | 607fd5d46253ff1109fc43cac5743be1 |
|
BLAKE2b-256 | 9ed8ad6a024f3f854b33f9d9e0e83c023427a6469b4706736b541d0f46d42706 |