https://github.com/aiidateam/aiida-restapi

AiiDA Web API for data queries and workflow management.
https://github.com/aiidateam/aiida-restapi

graphql rest-api server

Last synced: 5 days ago
JSON representation

AiiDA Web API for data queries and workflow management.

• Host: GitHub
• URL: https://github.com/aiidateam/aiida-restapi
• Owner: aiidateam
• License: mit
• Created: 2021-05-24T13:23:25.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-12-07T12:46:57.000Z (2 months ago)
• Last Synced: 2025-01-31T19:53:48.699Z (10 days ago)
• Topics: graphql, rest-api, server
• Language: Python
• Homepage: https://aiida-restapi.readthedocs.io
• Size: 286 KB
• Stars: 10
• Watchers: 5
• Forks: 7
• Open Issues: 30
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
[![Build Status](https://github.com/aiidateam/aiida-restapi/workflows/ci/badge.svg?branch=master)](https://github.com/aiidateam/aiida-restapi/actions)

[![Coverage Status](https://codecov.io/gh/aiidateam/aiida-restapi/branch/master/graph/badge.svg?token=zLdnsxfR3v)](https://codecov.io/gh/aiidateam/aiida-restapi)

[![Docs status](https://readthedocs.org/projects/aiida-restapi/badge)](http://aiida-restapi.readthedocs.io/)

[![PyPI version](https://badge.fury.io/py/aiida-restapi.svg)](https://badge.fury.io/py/aiida-restapi)

# aiida-restapi

AiiDA REST API for data queries and workflow management.

Uses [`pydantic`](https://pydantic-docs.helpmanual.io/) for models/validation and [`fastapi`](https://fastapi.tiangolo.com/) for the ASGI application.

Serve e.g. using [`uvicorn`](https://www.uvicorn.org/).

## Features

 * `/users` (GET/POST) and `/users/` (GET) endpoints

 * Authentication via [JSON web tokens](https://jwt.io/introduction) (see `test_auth.py` for the flow; also works via interactive docs)

 * `User` `pydantic` model for validation

 * Automatic documentation at `http://127.0.0.1:8000/docs`

 * Full specification at `http://127.0.0.1:8000/openapi.json`

## Installation

```shell

pip install aiida-restapi[auth]

```

## Usage

```shell

# start rest api

uvicorn aiida_restapi:app

# start rest api and reload for changes (for development)

uvicorn aiida_restapi:app --reload

```

## Examples

See the [examples](https://github.com/aiidateam/aiida-restapi/tree/master/examples) directory.

## Development

```shell

git clone https://github.com/aiidateam/aiida-restapi .

cd aiida-restapi

```

### Setting up pre-commit

We use pre-commit to take care for the formatting, type checking and linting.

```shell

pip install -e .[pre-commit]  # install extra dependencies

pre-commit run # running pre-commit on changes

pre-commit run --all-files # running pre-commit on every file

pre-commit run pylint --all-files # run only the linter on every file

```

One can also set up pre-commit to be run on every commit

```shell

pre-commit install

# pre-commit uninstall # to disable it again

```

### Running tests

With tox the tests can be run

```shell

pip install tox

tox -e py311 # run all tests for Python 3.11

tox -av # see all supported environments

```

tox will creat a custom environment to run the tests in. If you want to run the

tests inside your current environment

```shell

pip install -e .[testing]  # install extra dependencies

pytest -v

```

See the [developer guide](http://aiida-restapi.readthedocs.io/en/latest/developer_guide/index.html) for more information.

## License

MIT

## Contact

[email protected]

[email protected]