Metadata-Version: 2.1
Name: ocds-api.client.python
Version: 0.0.1b0
Summary: UNKNOWN
Home-page: https://github.com/openprocurement/ocds-api.client.python
Author: Quintagroup, Ltd.
Author-email: info@quintagroup.com
License: Apache Software License 2.0
Description: ﻿[![Build Status](https://travis-ci.com/openprocurement/ocds-api.client.python.svg?branch=master)](https://travis-ci.com/openprocurement/ocds-api.client.python)
        [![Coverage Status](https://coveralls.io/repos/github/openprocurement/ocds-api.client.python/badge.svg?branch=master)](https://coveralls.io/github/openprocurement/ocds-api.client.python?branch=master)
        
        
        # ocds-api.client.python
        
        A `python` data retrieving and synchronization client for the OCDS API.
        
        ## Installation
        
        Simply run from command line:
        ```
        pip install ocds-api.client.python
        ```
        
        ## Usage
        ### Retrieve
        ```py
        from ocds_client.clients import RecordClient
        ```
        ```py
        client = RecordClient('http://')
        ```
        To get a single `record` by `ocid` use method `get_record`:
        ```py
        record = client.get_record('ocid')
        ```
        To get multiple `records` by`page id` use method `get_records`:
        ```py
        records = client.get_records({'size': n , 'page': 'page id'})
        ```
        Similar actions can be taken with the client for `Releases`.
        ```py
        from ocds_client.clients import ReleaseClient
        ```
        Use methods `get_release` and `get_realeses`.
        
        ### Synchronization
        To synchronize, use `SyncClient` when initializing the **OCDS API host** and the resource to synchronize with.
        ```py
        from ocds_client.sync import SyncClient
        client = SyncClient('http://', 'record')
        for record in client.get_resource_items ():
        	# do smth with record
        ```
        
Keywords: ocds-client,ocds-api,ocds
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Development Status :: 4 - Beta
Description-Content-Type: text/markdown
Provides-Extra: test
