[FIX]Fixed licensing issues all across the module, [IMP]Improved documentation

Author: Sharoon Thomas

LICENSE

@@ -1,78 +1,8 @@
-                    GNU GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-                            Preamble
-
-  The GNU General Public License is a free, copyleft license for
-software and other kinds of works.
-
-  The licenses for most software and other practical works are designed
-to take away your freedom to share and change the works.  By contrast,
-the GNU General Public License is intended to guarantee your freedom to
-share and change all versions of a program--to make sure it remains free
-software for all its users.  We, the Free Software Foundation, use the
-GNU General Public License for most of our software; it applies also to
-any other work released this way by its authors.  You can apply it to
-your programs, too.
-
-  When we speak of free software, we are referring to freedom, not
-price.  Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-them if you wish), that you receive source code or can get it if you
-want it, that you can change the software or use pieces of it in new
-free programs, and that you know you can do these things.
-
-  To protect your rights, we need to prevent others from denying you
-these rights or asking you to surrender the rights.  Therefore, you have
-certain responsibilities if you distribute copies of the software, or if
-you modify it: responsibilities to respect the freedom of others.
-
-  For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must pass on to the recipients the same
-freedoms that you received.  You must make sure that they, too, receive
-or can get the source code.  And you must show them these terms so they
-know their rights.
-
-  Developers that use the GNU GPL protect your rights with two steps:
-(1) assert copyright on the software, and (2) offer you this License
-giving you legal permission to copy, distribute and/or modify it.
-
-  For the developers' and authors' protection, the GPL clearly explains
-that there is no warranty for this free software.  For both users' and
-authors' sake, the GPL requires that modified versions be marked as
-changed, so that their problems will not be attributed erroneously to
-authors of previous versions.
-
-  Some devices are designed to deny users access to install or run
-modified versions of the software inside them, although the manufacturer
-can do so.  This is fundamentally incompatible with the aim of
-protecting users' freedom to change the software.  The systematic
-pattern of such abuse occurs in the area of products for individuals to
-use, which is precisely where it is most unacceptable.  Therefore, we
-have designed this version of the GPL to prohibit the practice for those
-products.  If such problems arise substantially in other domains, we
-stand ready to extend this provision to those domains in future versions
-of the GPL, as needed to protect the freedom of users.
-
-  Finally, every program is threatened constantly by software patents.
-States should not allow patents to restrict development and use of
-software on general-purpose computers, but in those that do, we wish to
-avoid the special danger that patents applied to a free program could
-make it effectively proprietary.  To prevent this, the GPL assures that
-patents cannot be used to render the program non-free.
-
-  The precise terms and conditions for copying, distribution and
-modification follow.
-
-                       TERMS AND CONDITIONS
+TERMS AND CONDITIONS
 
   0. Definitions.
 
-  "This License" refers to version 3 of the GNU General Public License.
+  "This License" refers to version 3 of the GNU Affero General Public License.
 
   "Copyright" also means copyright-like laws that apply to other kinds of
 works, such as semiconductor masks.
@@ -549,35 +479,45 @@ to collect a royalty for further conveying from those to whom you convey
 the Program, the only way you could satisfy both those terms and this
 License would be to refrain entirely from conveying the Program.
 
-  13. Use with the GNU Affero General Public License.
+  13. Remote Network Interaction; Use with the GNU General Public License.
+
+  Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software.  This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
 
   Notwithstanding any other provision of this License, you have
 permission to link or combine any covered work with a work licensed
-under version 3 of the GNU Affero General Public License into a single
+under version 3 of the GNU General Public License into a single
 combined work, and to convey the resulting work.  The terms of this
 License will continue to apply to the part which is the covered work,
-but the special requirements of the GNU Affero General Public License,
-section 13, concerning interaction through a network will apply to the
-combination as such.
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
 
   14. Revised Versions of this License.
 
   The Free Software Foundation may publish revised and/or new versions of
-the GNU General Public License from time to time.  Such new versions will
-be similar in spirit to the present version, but may differ in detail to
+the GNU Affero General Public License from time to time.  Such new versions
+will be similar in spirit to the present version, but may differ in detail to
 address new problems or concerns.
 
   Each version is given a distinguishing version number.  If the
-Program specifies that a certain numbered version of the GNU General
+Program specifies that a certain numbered version of the GNU Affero General
 Public License "or any later version" applies to it, you have the
 option of following the terms and conditions either of that numbered
 version or of any later version published by the Free Software
 Foundation.  If the Program does not specify a version number of the
-GNU General Public License, you may choose any version ever published
+GNU Affero General Public License, you may choose any version ever published
 by the Free Software Foundation.
 
   If the Program specifies that a proxy can decide which future
-versions of the GNU General Public License can be used, that proxy's
+versions of the GNU Affero General Public License can be used, that proxy's
 public statement of acceptance of a version permanently authorizes you
 to choose that version for the Program.
 
@@ -618,57 +558,3 @@ an absolute waiver of all civil liability in connection with the
 Program, unless a warranty or assumption of liability accompanies a
 copy of the Program in return for a fee.
 
-                     END OF TERMS AND CONDITIONS
-
-            How to Apply These Terms to Your New Programs
-
-  If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
-  To do so, attach the following notices to the program.  It is safest
-to attach them to the start of each source file to most effectively
-state the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
-
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program 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 General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-Also add information on how to contact you by electronic and paper mail.
-
-  If the program does terminal interaction, make it output a short
-notice like this when it starts in an interactive mode:
-
-    <program>  Copyright (C) <year>  <name of author>
-    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
-    This is free software, and you are welcome to redistribute it
-    under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License.  Of course, your program's commands
-might be different; for a GUI interface, you would use an "about box".
-
-  You should also get your employer (if you work as a programmer) or school,
-if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU GPL, see
-<http://www.gnu.org/licenses/>.
-
-  The GNU General Public License does not permit incorporating your program
-into proprietary programs.  If your program is a subroutine library, you
-may consider it more useful to permit linking proprietary applications with
-the library.  If this is what you want to do, use the GNU Lesser General
-Public License instead of this License.  But first, please read
-<http://www.gnu.org/philosophy/why-not-lgpl.html>.

magento/__init__.py

@@ -1,14 +1,13 @@
 #!/usr/bin/env python
 # -*- coding: UTF-8 -*-
 '''
-    magento
-
-    Magento API - SOAP
+    magento API
 
     :copyright: (c) 2010 by Sharoon Thomas.
-    :license: GPLv3, see LICENSE for more details
+    :copyright: (c) 2010 by Openlabs Technologies & Consulting (P) LTD
+    :license: AGPLv3, see LICENSE for more details
 '''
-__version__ = '0.1.0'
+__version__ = '0.1.1'
 
 __all__ = [
             'API',

magento/api.py

@@ -6,7 +6,8 @@
     Generic API for magento
 
     :copyright: (c) 2010 by Sharoon Thomas.
-    :license: GPLv3, see LICENSE for more details
+    :copyright: (c) 2010 by Openlabs Technologies & Consulting (P) LTD
+    :license: AGPLv3, see LICENSE for more details
 '''
 from xmlrpclib import ServerProxy
 from suds.client import Client
@@ -29,6 +30,54 @@ class API(object):
     def __init__(self, url, username, password,
                  version='1.3.2.4', full_url=False, protocol='xmlrpc'):
         """
+        This is the Base API class which other APIs have to subclass. By
+        default the inherited classes also get the properties of this
+        class which will allow the use of the API with the `with` statement
+
+        A typical example to extend the API for your subclass is given below::
+
+           from magento.api import API 
+
+            class Core(API):
+            
+                __slots__ = ( )
+
+                def websites(self):
+                    return self.call('ol_websites.list', [])
+
+                def stores(self):
+                    return self.call('ol_groups.list', [])
+
+                def store_views(self):
+                    return self.call('ol_storeviews.list', [])
+
+        The above real life example extends the API for the custom API
+        implementation for the magento extension 
+
+            magento-community/Openlabs_OpenERPConnector
+
+        Example usage ::
+
+            from magento.api import API
+
+            with API(url, username, password) as magento_api:
+                return magento_api.call('customer.list', [])
+
+        .. note:: Python with statement has to be imported from __future__
+        in older versions of python. *from __futur__ import with_statement*
+
+        If you want to use the API as a normal class, then you have to manually
+        end the session. A typical example is below::
+
+            from magento.api import API
+
+            api = API(url, username, password)
+            api.connect()
+            try:
+                return api.call('customer.list', [])
+            finally:
+                api.client.endSession(api.session)
+
         :param url: URL to the magento instance.
                     By default the URL is treated as a base url
                     of the domain to which the api part of the URL

magento/catalog.py

@@ -6,7 +6,8 @@
     Product Catalog API for magento
 
     :copyright: (c) 2010 by Sharoon Thomas.
-    :license: GPLv3, see LICENSE for more details
+    :copyright: (c) 2010 by Openlabs Technologies & Consulting (P) LTD
+    :license: AGPLv3, see LICENSE for more details
 '''
 
 from magento.api import API

magento/customer.py

@@ -6,14 +6,23 @@
     Customer API for magento
 
     :copyright: (c) 2010 by Sharoon Thomas.
-    :license: GPLv3, see LICENSE for more details
+    :copyright: (c) 2010 by Openlabs Technologies & Consulting (P) LTD.
+
+    :license: AGPLv3, see LICENSE for more details
 '''
 
 from magento.api import API
 
 class Customer(API):
     """
-    Customer API to connect to magento
+    Customer API
+
+    Example usage::
+
+        from magento import Customer as CustomerAPI
+
+        with CustomerAPI(url, username, password) as customer_api:
+            return customer_api.list()
     """
     __slots__ = ( )
 

magento/directory.py

@@ -6,7 +6,8 @@
     Directory Country API for magento
 
     :copyright: (c) 2010 by Sharoon Thomas.
-    :license: GPLv3, see LICENSE for more details
+    :copyright: (c) 2010 by Openlabs Technologies & Consulting (P) LTD
+    :license: AGPLv3, see LICENSE for more details
 '''
 
 from magento.api import API

magento/utils.py

@@ -6,7 +6,8 @@
     General purpose utility functions
 
     :copyright: (c) 2010 by Sharoon Thomas.
-    :license: GPLv3, see LICENSE for more details
+    :copyright: (c) 2010 by Openlabs Technologies & Consulting (P) LTD.
+    :license: AGPLv3, see LICENSE for more details
     '''
 
 def expand_url(url, protocol):

setup.py

@@ -4,7 +4,8 @@
     Magento API
 
     :copyright: (c) 2010 by Sharoon Thomas.
-    :license: GPLv3, see LICENSE for more details
+    :copyright: (c) 2010 by Openlabs Technologies & Consulting (P) LTD
+    :license: AGPLv3, see LICENSE for more details
 
     A simple to use python library to access the magento API and
     covered by a complete test suite based on Nose tests. Also
@@ -32,8 +33,8 @@
 setup(
     name = 'magento',
     version=magento.__version__,
-    url='http://openlabs.co.in/projects/python/magento',
-    license='GPL',
+    url='http://projects.openlabs.co.in/trac/openlabs_magento',
+    license='GNU Affero General Public License v3',
     author='Sharoon Thomas, Openlabs Technologies',
     author_email='[email protected]',
     description='Magento E-Commerce Integration',
@@ -48,7 +49,7 @@
         'Development Status :: 4 - Beta',
         'Environment :: Web Environment',
         'Intended Audience :: Developers',
-        'License :: OSI Approved :: GPL License',
+        'License :: OSI Approved :: GNU Affero General Public License v3', 
         'Operating System :: OS Independent',
         'Programming Language :: Python',
         'Topic :: Internet :: WWW/HTTP :: Dynamic Content',