Metadata-Version: 1.0
Name: prestapyt
Version: 0.6.1
Summary: A library to access Prestashop Web Service from Python.
Home-page: http://github.com/guewen/prestapyt
Author: Guewen Baconnier
Author-email: guewen.baconnier@gmail.com
License: GNU AGPL-3
Description: Prestapyt
        =========
        
        prestapyt is a library for Python to interact with the PrestaShop's Web Service API.
        
        Learn more about the PrestaShop Web Service from the [Official Prestashop Documentation].
        
        prestapyt is a direct port of the PrestaShop PHP API Client, PSWebServiceLibrary.php
        
        Similar to PSWebServiceLibrary.php, prestapyt is a thin wrapper around the PrestaShop Web Service:
        it takes care of making the call to your PrestaShop instance's Web Service,
        supports the Web Service's HTTP-based CRUD operations (handling any errors)
        and then returns the XML ready for you to work with in Python
        (as well as prestasac if you work with scala).
        
        
        Installation
        ============
        
        The easiest way to install prestapyt (needs setuptools):
        
            easy_install prestapyt
        
        Or, better, using pip:
        
            pip install prestapyt
        
        If you do not have setuptools, download prestapyt as a .tar.gz or .zip from
        [Prestapyt Source Archives], untar it and run:
        
            python setup.py install
        
        
        Usage
        =====
        
            from prestapyt import PrestaShopWebServiceError, PrestaShopWebService
        
            prestashop = PrestaShopWebService('http://localhost:8080/api', 'BVWPFFYBT97WKM959D7AVVD0M4815Y1L')  # messages will be as xml
            # or
            prestashop = PrestaShopWebServiceDict('http://localhost:8080/api', 'BVWPFFYBT97WKM959D7AVVD0M4815Y1L')  # messages will be as dict
        
            # search / get all addresses
            prestashop.get('addresses') # will return the same xml message than
            prestashop.search('addresses')
            # but when using PrestaShopWebServiceDict
            prestashop.search('addresses') will return a list of ids
        
            # search with filters
            prestashop.search('addresses', options={'limit': 10})
            prestashop.search('addresses', options={'display': '[firstname,lastname]', 'filter[id]': '[1|5]'})
            # reference for the options : http://doc.prestashop.com/display/PS14/Cheat+Sheet_+Concepts+Outlined+in+this+Tutorial
        
            # get address 1
            prestashop.get('addresses', resource_id=1) # returns ElementTree (PrestaShopWebService) or dict (PrestaShopWebServiceDict)
            prestashop.get('addresses/1')
        
            # full url
            prestashop.get('http://localhost:8080/api/addresses/1')
        
            # head
            print prestashop.head('addresses')
        
            # delete a resource
            prestashop.delete('addresses', resource_ids=4)
        
            # delete many resources
            prestashop.delete('addresses', resource_ids=[5,6])
        
            # add
            prestashop.add('addresses', xml)
        
            # edit
            prestashop.edit('addresses', 5, xml)
        
            # get a blank xml
            prestashop.get('addresses', options={'schema': 'blank'})
        
            # add product image
            file_name = 'sample.jpg'
            fd        = io.open(file_name, "rb")
            content   = fd.read()
            fd.close()
        
            prestashop.add('/images/products/123', files=[('image', file_name, content)])
        
        API Documentation
        =================
        
        Documentation for the PrestaShop Web Service can be found on the
        PrestaShop wiki: [Using the REST webservice]
        
        
        Credits:
        ========
        
        Thanks to Prestashop SA for their PHP API Client PSWebServiceLibrary.php
        
        Thanks to Alex Dean for his port of PSWebServiceLibrary.php
        to the Scala language, [prestasac] from which I also inspired my library.
        
        
        Copyright and License
        =====================
        
        prestapyt is copyright (c) 2012 Guewen Baconnier
        
        prestapyt is free software: you can redistribute it and/or modify
        it under the terms of the GNU Affero General Public License as
        published by the Free Software Foundation, either version 3 of
        the License, or (at your option) any later version.
        
        prestapyt is distributed in the hope that it will be useful,
        but WITHOUT ANY WARRANTY; without even the implied warranty of
        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
        GNU Affero General Public License for more details.
        
        You should have received a copy of the GNU Affero General Public
        License along with prestapyt. If not, see [GNU licenses](http://www.gnu.org/licenses/).
        
        
        
        [Official Prestashop Documentation]: http://doc.prestashop.com/display/PS14/Using+the+REST+webservice
        [Using the REST webservice]: http://doc.prestashop.com/display/PS14/Using+the+REST+webservice
        [Prestapyt Source Archives]: https://github.com/guewen/prestapyt/downloads
        [prestasac]: https://github.com/orderly/prestashop-scala-client
        
        
Keywords: prestashop api client rest
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
Classifier: Topic :: Internet
