{"id":25019469,"url":"https://github.com/aiidateam/aiida-restapi","last_synced_at":"2025-09-05T03:42:54.494Z","repository":{"id":45195778,"uuid":"370360328","full_name":"aiidateam/aiida-restapi","owner":"aiidateam","description":"AiiDA Web API for data queries and workflow management.","archived":false,"fork":false,"pushed_at":"2024-12-07T12:46:57.000Z","size":293,"stargazers_count":11,"open_issues_count":34,"forks_count":8,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-09-01T00:09:31.955Z","etag":null,"topics":["graphql","rest-api","server"],"latest_commit_sha":null,"homepage":"https://aiida-restapi.readthedocs.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aiidateam.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-05-24T13:23:25.000Z","updated_at":"2025-05-31T06:49:38.000Z","dependencies_parsed_at":"2024-05-22T10:43:47.631Z","dependency_job_id":"987d52f8-6f53-4f5b-9a90-f8042908e7f5","html_url":"https://github.com/aiidateam/aiida-restapi","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/aiidateam/aiida-restapi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aiidateam%2Faiida-restapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aiidateam%2Faiida-restapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aiidateam%2Faiida-restapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aiidateam%2Faiida-restapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aiidateam","download_url":"https://codeload.github.com/aiidateam/aiida-restapi/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aiidateam%2Faiida-restapi/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273708987,"owners_count":25153728,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-05T02:00:09.113Z","response_time":402,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["graphql","rest-api","server"],"created_at":"2025-02-05T11:50:41.641Z","updated_at":"2025-09-05T03:42:49.480Z","avatar_url":"https://github.com/aiidateam.png","language":"Python","readme":"[![Build Status](https://github.com/aiidateam/aiida-restapi/workflows/ci/badge.svg?branch=master)](https://github.com/aiidateam/aiida-restapi/actions)\n[![Coverage Status](https://codecov.io/gh/aiidateam/aiida-restapi/branch/master/graph/badge.svg?token=zLdnsxfR3v)](https://codecov.io/gh/aiidateam/aiida-restapi)\n[![Docs status](https://readthedocs.org/projects/aiida-restapi/badge)](http://aiida-restapi.readthedocs.io/)\n[![PyPI version](https://badge.fury.io/py/aiida-restapi.svg)](https://badge.fury.io/py/aiida-restapi)\n\n# aiida-restapi\n\nAiiDA REST API for data queries and workflow management.\n\nUses [`pydantic`](https://pydantic-docs.helpmanual.io/) for models/validation and [`fastapi`](https://fastapi.tiangolo.com/) for the ASGI application.\nServe e.g. using [`uvicorn`](https://www.uvicorn.org/).\n\n## Features\n\n * `/users` (GET/POST) and `/users/\u003cid\u003e` (GET) endpoints\n * Authentication via [JSON web tokens](https://jwt.io/introduction) (see `test_auth.py` for the flow; also works via interactive docs)\n * `User` `pydantic` model for validation\n * Automatic documentation at `http://127.0.0.1:8000/docs`\n * Full specification at `http://127.0.0.1:8000/openapi.json`\n\n## Installation\n\n```shell\npip install aiida-restapi[auth]\n```\n\n## Usage\n\n```shell\n# start rest api\nuvicorn aiida_restapi:app\n\n# start rest api and reload for changes (for development)\nuvicorn aiida_restapi:app --reload\n```\n\n## Examples\n\nSee the [examples](https://github.com/aiidateam/aiida-restapi/tree/master/examples) directory.\n\n## Development\n\n```shell\ngit clone https://github.com/aiidateam/aiida-restapi .\ncd aiida-restapi\n```\n\n### Setting up pre-commit\n\nWe use pre-commit to take care for the formatting, type checking and linting.\n```shell\npip install -e .[pre-commit]  # install extra dependencies\npre-commit run # running pre-commit on changes\npre-commit run --all-files # running pre-commit on every file\npre-commit run pylint --all-files # run only the linter on every file\n```\nOne can also set up pre-commit to be run on every commit\n```shell\npre-commit install\n# pre-commit uninstall # to disable it again\n```\n\n### Running tests\n\nWith tox the tests can be run\n```shell\npip install tox\ntox -e py311 # run all tests for Python 3.11\ntox -av # see all supported environments\n```\ntox will creat a custom environment to run the tests in. If you want to run the\ntests inside your current environment\n```shell\npip install -e .[testing]  # install extra dependencies\npytest -v\n```\n\nSee the [developer guide](http://aiida-restapi.readthedocs.io/en/latest/developer_guide/index.html) for more information.\n\n## License\n\nMIT\n\n## Contact\n\nleopold.talirz@gmail.com\nchrisj_sewell@hotmail.com\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faiidateam%2Faiida-restapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faiidateam%2Faiida-restapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faiidateam%2Faiida-restapi/lists"}