Metadata-Version: 1.1
Name: srgssr-publication-data-api
Version: 0.3.2
Summary: Python client library to conveniently query the publication data of SRG/SSR
Home-page: https://github.com/SRGSSR/pdp_graphql_client_python
Author: SRGSSR PDP Team
Author-email: pdp@srgssr.ch
License: MIT license
Description: =========================
        PDP GraphQL client Python
        =========================
        
        
        .. image:: https://img.shields.io/pypi/v/pdp_graphql_client_python.svg
                :target: https://pypi.org/project/pdp_graphql_client_python
        
        .. image:: https://img.shields.io/travis/SRGSSR/pdp_graphql_client_python.svg
                :target: https://travis-ci.org/SRGSSR/pdp_graphql_client_python
        
        .. image:: https://readthedocs.org/projects/pdp-graphql-client-python/badge/?version=latest
                :target: https://pdp-graphql-client-python.readthedocs.io/en/latest/?badge=latest
                :alt: Documentation Status
        
        
        
        
        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
        --------
        
        #. create a ``.env`` file in the root directory file with the following Variables
        
           .. code-block::
        
                PDP_API=https://graphql-api.pdp.dev.srgssr.ch/graphql
                USER_NAME=[your_email]
                USER_PASSWORD=[your_password]
        
        #. then it should work, this is a simple code snippet to extract the data
        
            .. code-block::
        
                from sgqlc.types import Variable, non_null
                from sgqlc.operation import Operation
                from srgssr_publication_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'])
        
        #. 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`_.
        
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`elgertam/cookiecutter-pipenv`: https://github.com/elgertam/cookiecutter-pipenv
        .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
        
        
        =======
        History
        =======
        
        0.3.2 (2021-03-24)
        ------------------
        
        * Removed the dependency on Click
        
        
        0.3.1 (2021-03-24)
        ------------------
        
        * Fixed typo in README.rst
        * Added missing dependency to sgqlc
        
        
        0.3.0 (2021-03-23)
        ------------------
        
        * First release on PyPI.
        
Keywords: srgssr metadata pdp publication data
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
