Merge branch 'dev'

Author: AverHLV

MANIFEST

@@ -1,4 +1,5 @@
 # file GENERATED by distutils, do NOT edit
+README.rst
 setup.cfg
 setup.py
 browseapi\__init__.py

README.md

@@ -0,0 +1,78 @@
+Browse API client
+=================
+
+|coverage| |build_status| |Documentation Status| |PyPI version|
+
+This package is a Python client for eBay Browse API. It is asynchronous
+and designed to send a large number of requests by one function call.
+
+For more information about this API visit official
+`documentation <https://developer.ebay.com/api-docs/buy/browse/overview.html>`__.
+
+Installation
+------------
+
+Install from PyPI by ``pip install browseapi``
+
+Supported methods
+-----------------
+
+Only these methods are now implemented (names changed to lowercase
+notation):
+
+-  `search <https://developer.ebay.com/api-docs/buy/browse/resources/item_summary/methods/search>`__
+-  `search\_by\_image <https://developer.ebay.com/api-docs/buy/browse/resources/search_by_image/methods/searchByImage>`__
+
+Quickstart
+----------
+
+Create a BrowseAPI instance with your application id (app\_id) and
+application secret (cert\_id) and start sending requests:
+
+.. code:: python
+
+    from browseapi import BrowseAPI
+
+    app_id = '<your_app_id>'
+    cert_id = '<your_cert_id>'
+
+    api = BrowseAPI(app_id, cert_id)
+    responses = api.execute('search', [{'q': 'drone', 'limit': 50}, {'category_ids': 20863}])
+
+    # this will make 'search' request two times with parameters
+    # q=drone and limit=50 for the first time and
+    # category_ids=20863 for the second time
+
+    print(responses[0].itemSummaries[0])
+
+All response fields have similar names and types as those mentioned in
+official docs.
+
+Tests
+-----
+
+For running tests put your ``secret.json`` file with fields
+``'eb_app_id'`` and ``'eb_cert_id'`` to the ``browseapi/tests``
+directory, then run a command from the parent browseapi directory:
+
+``python -m unittest browseapi.tests.test_client``
+
+Requirements
+------------
+
+-  Python >= 3.5.3
+-  `aiohttp <https://aiohttp.readthedocs.io/en/stable/>`__
+
+Documentation
+-------------
+
+Documentation built with `mkdocs <https://www.mkdocs.org/>`__.
+
+`browseapi.readthedocs.io <https://browseapi.readthedocs.io/en/latest/>`__
+
+.. |coverage| image:: https://img.shields.io/codecov/c/github/AverHLV/browseapi.svg
+.. |build_status| image:: https://img.shields.io/gitlab/pipeline/AverHLV/browseapi/dev.svg
+.. |Documentation Status| image:: https://readthedocs.org/projects/browseapi/badge/?version=latest
+   :target: https://browseapi.readthedocs.io/en/latest/?badge=latest
+.. |PyPI version| image:: https://badge.fury.io/py/browseapi.svg
+   :target: https://badge.fury.io/py/browseapi

README.rst

@@ -1,21 +1,20 @@
 from distutils.core import setup
 
-with open('README.md') as f:
+with open('README.rst') as f:
     long_description = f.read()
 
 
 setup(
     name='browseapi',
     packages=['browseapi'],
-    version='0.10',
+    version='0.11',
     license='MIT',
     description='eBay Browse API Python client',
     long_description=long_description,
-    long_description_content_type='text/markdown',
     author='Andrii Matiiash',
     author_email='[email protected]',
     url='https://github.com/AverHLV/browseapi',
-    download_url='https://github.com/AverHLV/browseapi/archive/0.10.tar.gz',
+    download_url='https://github.com/AverHLV/browseapi/archive/0.11.tar.gz',
     keywords=['ASYNC', 'BROWSE API', 'CLIENT'],
 
     install_requires=[