Metadata-Version: 2.1
Name: amightygirl.paapi5-python-sdk
Version: 1.0.0
Summary: ProductAdvertisingAPI 5.0 Python SDK
Home-page: https://webservices.amazon.com/paapi5/documentation/
Author: A Mighty Girl
Author-email: admin@amightygirl.com
License: Apache License 2.0
Description: # Product Advertising API 5.0 SDK for Python (v1)
        
        
        ## About This Package
        
        This repository contains the official Product Advertising API 5.0 Python SDK called **paapi5-python-sdk** that allows you to access the [Product Advertising API](https://webservices.amazon.com/paapi5/documentation/index.html).
        
        The code in this package was written entirely by Amazon.com. Based on the original documentation, it appears that Amazon originally intended to make this package available via `pip`; however, it appears that either (a) that never happened or (b) they removed it. We created this package to correct that.
        
        The only changes we made to Amazon's original package were:
        1. Modifying this README file to reflect the correct pip package information
        2. Modifying the setup.py file
        
        ## Documentation and Original SDK
        
        Amazon's documentation for the Product Advertising API can be found at:
        
        https://webservices.amazon.com/paapi5/documentation/index.html
        
        You can download the original SDK from Amazon.com at:
        
        https://webservices.amazon.com/paapi5/documentation/quick-start/using-sdk.html
        
        ## Requirements
        
        Python 2.7 and 3.4+
        
        ## Installation & Usage
        
        ### pip install
        
        You can directly install it from pip using:
        
        ```sh
        pip install amightygirl.paapi5-python-sdk
        ```
        
        Then import the package:
        ```python
        import paapi5_python_sdk
        ```
        
        ## Getting Started
        
        Please follow the [installation procedure](#installation--usage) and then run the following:
        
        Simple example for [SearchItems](https://webservices.amazon.com/paapi5/documentation/search-items.html) to discover Amazon products with the keyword 'Harry Potter' in All categories:
        
        ```python
        from __future__ import print_function
        
        from paapi5_python_sdk.api.default_api import DefaultApi
        from paapi5_python_sdk.search_items_request import SearchItemsRequest
        from paapi5_python_sdk.search_items_resource import SearchItemsResource
        from paapi5_python_sdk.partner_type import PartnerType
        from paapi5_python_sdk.rest import ApiException
         
         
        def search_items():
        
            """ Following are your credentials """
            """ Please add your access key here """
            access_key = "<YOUR ACCESS KEY>"
        
            """ Please add your secret key here """
            secret_key = "<YOUR SECRET KEY>"
        
            """ Please add your partner tag (store/tracking id) here """
            partner_tag = "<YOUR PARTNER TAG>"
        
            """ PAAPI Host and Region to which you want to send request """
            """ For more details refer: https://webservices.amazon.com/paapi5/documentation/common-request-parameters.html#host-and-region"""
            host = "webservices.amazon.com"
            region = "us-east-1"
        
            """ API declaration """
            default_api = DefaultApi(
                access_key=access_key, secret_key=secret_key, host=host, region=region
            )
        
            """ Request initialization"""
        
            """ Specify keywords """
            keywords = "Harry Potter"
        
            """ Specify the category in which search request is to be made """
            """ For more details, refer: https://webservices.amazon.com/paapi5/documentation/use-cases/organization-of-items-on-amazon/search-index.html """
            search_index = "All"
        
            """ Specify item count to be returned in search result """
            item_count = 1
        
            """ Choose resources you want from SearchItemsResource enum """
            """ For more details, refer: https://webservices.amazon.com/paapi5/documentation/search-items.html#resources-parameter """
            search_items_resource = [
                SearchItemsResource.IMAGES_PRIMARY_LARGE,
                SearchItemsResource.ITEMINFO_TITLE,
                SearchItemsResource.OFFERS_LISTINGS_PRICE,
            ]
        
            """ Forming request """
            try:
                search_items_request = SearchItemsRequest(
                    partner_tag=partner_tag,
                    partner_type=PartnerType.ASSOCIATES,
                    keywords=keywords,
                    search_index=search_index,
                    item_count=item_count,
                    resources=search_items_resource,
                )
            except ValueError as exception:
                print("Error in forming SearchItemsRequest: ", exception)
                return
        
            try:
                """ Sending request """
                response = default_api.search_items(search_items_request)
        
                print("API called Successfully")
                print("Complete Response:", response)
        
                """ Parse response """
                if response.search_result is not None:
                    print("Printing first item information in SearchResult:")
                    item_0 = response.search_result.items[0]
                    if item_0 is not None:
                        if item_0.asin is not None:
                            print("ASIN: ", item_0.asin)
                        if item_0.detail_page_url is not None:
                            print("DetailPageURL: ", item_0.detail_page_url)
                        if (
                            item_0.item_info is not None
                            and item_0.item_info.title is not None
                            and item_0.item_info.title.display_value is not None
                        ):
                            print("Title: ", item_0.item_info.title.display_value)
                        if (
                            item_0.offers is not None
                            and item_0.offers.listings is not None
                            and item_0.offers.listings[0].price is not None
                            and item_0.offers.listings[0].price.display_amount is not None
                        ):
                            print(
                                "Buying Price: ", item_0.offers.listings[0].price.display_amount
                            )
                if response.errors is not None:
                    print("\nPrinting Errors:\nPrinting First Error Object from list of Errors")
                    print("Error code", response.errors[0].code)
                    print("Error message", response.errors[0].message)
        
            except ApiException as exception:
                print("Error calling PA-API 5.0!")
                print("Status code:", exception.status)
                print("Errors :", exception.body)
                print("Request ID:", exception.headers["x-amzn-RequestId"])
        
            except TypeError as exception:
                print("TypeError :", exception)
        
            except ValueError as exception:
                print("ValueError :", exception)
        
            except Exception as exception:
                print("Exception :", exception)
         
        search_items()
        ```
        Complete documentation, installation instructions, and examples are available [here](https://webservices.amazon.com/paapi5/documentation/index.html).
        
        
        ## License
        
        This SDK is distributed under the
        [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),
        see LICENSE.txt and NOTICE.txt for more information.
        
Keywords: ProductAdvertisingAPI,pa-api,paapi,amazon
Platform: UNKNOWN
Requires-Python: >=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*
Description-Content-Type: text/markdown
