Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
build
dist
prestapyt.egg-info
*.pyc
tags
5 changes: 5 additions & 0 deletions CREDITS
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
CREDITS
-------
Camptocamp SA
Akretion
Mark Rainess (mrainess)
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
include README.md
77 changes: 0 additions & 77 deletions README

This file was deleted.

56 changes: 45 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,38 @@
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 Documentation](http://doc.prestashop.com/display/PS14/Using+the+REST+webservice).
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
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

If you do not have setuptools, download prestapyt as a .tar.gz or .zip from here (https://github.com/guewen/prestapyt/downloads), untar it and run:
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

Usage
=====

from prestapyt import PrestaShopWebServiceError, PrestaShopWebService

Expand Down Expand Up @@ -59,16 +76,25 @@ If you do not have setuptools, download prestapyt as a .tar.gz or .zip from here
# get a blank xml
prestashop.get('addresses', options={'schema': 'blank'})

#API Documentation
Documentation for the PrestaShop Web Service can be found on the PrestaShop wiki:
[Using the REST webservice](http://doc.prestashop.com/display/PS14/Using+the+REST+webservice)

#Credits:
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 (https://github.com/orderly/prestashop-scala-client) from which I also inspired my library.
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

Copyright and License
=====================

prestapyt is copyright (c) 2012 Guewen Baconnier

Expand All @@ -84,3 +110,11 @@ 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

Loading