Metadata-Version: 2.1
Name: srgssr-publication-data-api
Version: 0.4.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
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
Requires-Dist: sgqlc

=========================
PDP GraphQL client Python
=========================


.. image:: https://img.shields.io/pypi/v/srgssr-publication-data-api.svg
        :target: https://pypi.org/project/srgssr-publication-data-api



API Client 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
--------

.. code-block::

    from sgqlc.types import Variable, non_null
    from srgssr_publication_data_api import PublicationDataApi

    # replace url, username, password with real values
    client = PublicationDataApi(url, username, password)

    op = client.query_op()

    # to restrict fields to just title and cursor (for pagination):
    selector = op.faro_items(first=5)
    selector.edges().title()
    selector.cursor()

    # if you just want to see the schema, just remove the selector.

    result = client.run_query(op)
    print(result)

#. 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.4.1 (2021-03-24)
------------------

* fixed the old links in the README.rst



0.4.0 (2021-03-24)
------------------

* Removed the dependency on environment variables.
* Moved to class design.


0.3.3 (2021-03-24)
------------------

* Nothing changed, just testing the release pipeline.


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.


