srgssr-publication-data-api 0.3.0

Python client library to conveniently query the publication data of SRG/SSR

PDP GraphQL client Python

Example repository of how to access PDP’s GraphQL API through python

• Free software: MIT license

• Build upon the Simple GraphQL Client sgqlc (https://github.com/profusion/sgqlc)

USAGE

1. create a .env file in the root directory file with the following Variables

   PDP_API=https://graphql-api.pdp.dev.srgssr.ch/graphql
   USER_NAME=[your_email]
   USER_PASSWORD=[your_password]

2. then it should work, this is a simple code snippet to extract the data

   from sgqlc.types import Variable, non_null
   from sgqlc.operation import Operation
   from srgssr_publicdation_data_api import client, pdp_schema
   
   op = Operation(schema.Query, name='faroItems', variables={'first':non_null(int), 'after':str})
   
   # to restrict fields to just title and cursor (for pagination):
   selector = op.faro_items(first=Variable('first'), after=Variable('after'))
   selector.edges.title()
   selector.cursor()
   
   # if you just want to see the schema, just remove the selector.
   
   print(client.run_query(op, {'first': 100})['data'])

3. for more details about building the queries, see also sgqlc usage docs (https://github.com/profusion/sgqlc#usage)

Development

For development check the documentation under docs/installation.rst.

Credits

This package was created with Cookiecutter and the elgertam/cookiecutter-pipenv project template, based on audreyr/cookiecutter-pypackage.

History

0.3.0 (2021-03-23)

• First release on PyPI.