Metadata-Version: 2.1
Name: apitalker
Version: 0.3.0
Summary: Python wrapper for using Apitalks API.
Home-page: https://github.com/bednaJedna/att
Author: Radek 'bednaJedna' Bednarik
Author-email: bednarik.radek@gmail.com
License: UNKNOWN
Description: # Apitalker
        
        ![Upload Python Package](https://github.com/bednaJedna/att/workflows/Upload%20Python%20Package/badge.svg)
        
        ## Table of Contents
        
        - [About](#about)
        - [Getting Started](#getting_started)
        - [Usage](#usage)
          - [Examples](#examples)
        
        ## About <a name = "about"></a>
        
        Python3 library. Wrapper for [Apitalks API](https://www.api.store/) calls. Enables simple call for api resource via `query` method with optional use of available parameters, as specified in [Apitalks documentation](https://www.api.store/czso.cz/dokumentace#section/Query-parametry).
        
        ## Getting Started <a name = "getting_started"></a>
        
        These instructions will get you up and running.
        
        ### Prerequisites
        
        What things you need to install the software.
        
            - Python 3+
        
        ### Installing
        
        To install this package, simply use standard `pip install apitalker` or clone this repo and run `python setup.py install`.
        
        ## Usage <a name = "usage"></a>
        
        apitalker is used as any other library.
        
        ```
        from apitalker.api import API
        
        api = API("yourAPIkeygoeshere")
        r = api.query([resource], [...params])
        ```
        
        Returned data are treated as instance of a class `ApiResponse`. You can access following attributes:
        
        ```
        ApiResponse.response - complete json-decoded call return
        ApiResponse.data - data part of json-decoded call return
        ApiResponse.skip - skip value
        ApiResponse.count - count value
        ApiResponse.limit - limit value
        ApiResponse.info - info value
        ApiResponse.provider - provider value
        ```
        
        Error messages in case there are some problems with api call, are handled by class `ApiError`. You can following attributes:
        
        ```
        ApiError.response - complete json-decoded call return
        ApiError.error - error part of call return
        ApiError.status_code - HTTP status code
        ApiError.name - name of the error message
        ApiError.message - error message itself
        ```
        
        ### Examples <a name = "examples"></a>
        
        **Call resource only, with no query parameters**
        
        As is specified in [API documentation](https://www.api.store/czso.cz/dokumentace#section/Query-parametry), without any query parameters provided, API call will return one "page" of results, which equals of maximum of 30 data entries and 0 "pages" will be skipped.
        
        ```
        from apitalker.api import API
        
        api = API("yourAPIkeygoeshere")
        r = api.query("/czso.cz/lide-domy-byty")
        ```
        
        **Call resource with limited page size and skipped one page of the same size**
        
        ```
        from apitalker.api import API
        
        api = API("yourAPIkeygoeshere")
        r = api.query("/czso.cz/lide-domy-byty", limit=10, skip=10)
        ```
        
        **Returned data can be ordered**
        
        Pay attention to the quotes usage in the `order` parameter values!
        
        ```
        from apitalker.api import API
        
        api = API("yourAPIkeygoeshere")
        r = api.query("/czso.cz/lide-domy-byty", limit=10, skip=10, order='"nazev ASC, u01 DESC"')
        ```
        
        **Other filtering is possible using `where` parameter**
        
        This is dependent on the data source.
        
        ```
        from apitalker.api import API
        
        api = API("yourAPIkeygoeshere")
        r = api.query("/czso.cz/lide-domy-byty", where='"uzkod":568741, "year":1999')
        ```
        
Keywords: api Apitalks wrapper python3 data library utility
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Other Audience
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Description-Content-Type: text/markdown
