Software Heritage GraphQL Apis
Project description
This repository holds the development of Software Heritage GraphQL API. A staging version of this service is available at https://graphql.staging.swh.network
Running locally
Refer to https://docs.softwareheritage.org/devel/getting-started.html#getting-started for running software heritage services locally.
If you wish to run SWH-GraphQL independently, and have access to SWH storage services, following make targets can be used.
make run-dev: Use the config file at swh/graphql/config/dev.yml and start the service in auto-reload mode using uvicorn
make run-dev-stable: Use the config file at swh/graphql/config/dev.yml and start the service using uvicorn
make run-dev-docker: Run the service inside a docker container and Use the config file at swh/graphql/config/dev.yml
make run-wsgi-docker: Run the service inside a docker container and Use the config file at swh/graphql/config/staging.yml
visit http://localhost:8000 to use the query explorer
Running a query
The easiest way to run a query is using the query explorer. Please provide an SWH API token if you wish to run bigger queries.
Using curl
curl -i -H 'Content-Type: application/json' -H "Authorization: bearer your-api-token" -X POST -d '{"query": "query {origins(first: 2) {nodes {url}}}"}' http://127.0.0.1:8000
Using Python requests
import requests
url = "http://127.0.0.1:8000"
query = """
{
origins(first: 2) {
pageInfo {
hasNextPage
endCursor
}
edges {
node {
url
}
}
}
}
"""
json = {"query" : query}
api_token = "your-api-token"
headers = {'Authorization': 'Bearer %s' % api_token}
r = requests.post(url=url, json=json, headers=headers)
print (r.json())
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
Hashes for swh.graphql-0.0.92-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e239ecf703d42c582a622c7cb508bf8a50ad0952c8e7a005516612f73a17063a |
|
MD5 | fa7c32c1fb73adb7de45d54c30ef8736 |
|
BLAKE2b-256 | 61c5dc1ac9e52773ce73a4b0e454dfa7c4a43c63779ba51620a260a141f12643 |