doc updates

timotheus · timotheus · commit 2000e2c732a8 · 2014-01-31T11:24:40.000-08:00
diff --git a/Changes b/Changes
@@ -2,6 +2,12 @@ Changes for ebaysdk
 
 1.0.0
 - Major refactor
+  + changes are backward compatible unless your subclassing any of the 
+    SDK classes
+  + moved from PyCurl to Python Requests
+  + code organization
+  + standard python logging
+  + add exceptions
 
 0.1.11
 - Add affiliate headers to the Shopping API back-end
diff --git a/INSTALL b/INSTALL
@@ -3,9 +3,7 @@ Running the tests:
 
 Installing ebaysdk on Mac:
 
-1) Install Xcode from the app center
-2) Download and install the Xcode Command Line Tools from https://developer.apple.com/downloads/
-3) Install the SDK
+1) Install the SDK with easy_install
    
    sudo easy_install ebaysdk
    
@@ -15,15 +13,15 @@ Installing ebaysdk on Mac:
    
 Installing ebaysdk on Windows:
 
-1) Download and install the latest release of Python 2.7: 
+1) Download and install the latest release of Python 2.7+
 
 http://python.org/download/
 
 Choose either "Python 3.3.0 Windows x86 MSI Installer" or "Python
 3.3.0 Windows X86-64 MSI Installer". To use the latter, you must be
 running a 64-bit version of Windows. 
 
-2) Install setuptools:
+2) Install setuptools
 
 First, visit http://pypi.python.org/pypi/setuptools
 
@@ -43,23 +41,7 @@ setuptools, then run it from the command prompt as follows:
 The last step assumes that Python was installed to its default
 location.
 
-3) Install pycurl:
-
-This could be complicated because pycurl requires libcurl to be
-installed. Since this is a native library, this can't be installed
-using pip or easy_install. Luckily Christoph Gohlke has pre-complied
-many common libraries for Python on Windows, including 32- and 64-bit
-versions.
-
-Simply visit this site:
- 
-http://www.lfd.uci.edu/~gohlke/pythonlibs/
-
-Then download and install the appropriate version of pycurl for Python
-2.7. Use the amd64 version if you are running 64-bit
-Python. Otherwise, use the win32 version.
-
-4) Install ebaysdk:
+3) Install ebaysdk
 
 Download and extract the zipball, or clone the ebaysdk-python
 repository. Then open the Command Prompt and change to the root
@@ -69,24 +51,3 @@ directory of the distribution and execute:
 
 If there were no errors, ebaysdk should be ready to use!
 
-
-
-Legacy Install on Mac:
-
-Dependency: pycurl
-
-    How to install pycurl on Mac
-
-    1) Install Fink
-       http://www.finkproject.org/download/
-       
-    2) Install libssh2, libcurl4-shlibs
-       sudo /sw/bin/apt-get install libssh2
-       sudo /sw/bin/apt-get -q0 -f install libcurl4-shlibs
-
-    3) Download pycurl from http://pycurl.sourceforge.net/download/
-
-    4) Extract and install pycurl 
-       tar -zxvf pycurl-7.16.4.tar.gz 
-       cd pycurl-7.16.4 
-       sudo env ARCHFLAGS="-arch i386" python setup.py install --curl-config=/sw/bin/curl-config
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,5 +1,6 @@
 recursive-include ebaysdk *.py
 recursive-include tests *.py
+recursive-include samples *.py
 include ebay.yaml
 include Changes
 include INSTALL
diff --git a/README.rst b/README.rst
@@ -5,9 +5,9 @@ This SDK is a programmatic interface into the eBay APIs. It simplifies developme
 
 Quick Example::
 
-    from ebaysdk import finding
+    from ebaysdk.finding import Connection
 
-    api = finding(appid='YOUR_APPID_HERE')
+    api = Connection(appid='YOUR_APPID_HERE')
     api.execute('findItemsAdvanced', {'keywords': 'shoes'})        
 
     print api.response_dict()
diff --git a/setup.py b/setup.py
@@ -34,18 +34,18 @@
 setup(
     name=PKG,
     version=version,
-    description="Simple and Extensible eBay SDK for Python",
+    description="eBay SDK for Python",
     author="Tim Keefer",
     author_email="tkeefer@gmail.com",
     url="https://github.com/timotheus/ebaysdk-python",
     license="COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL) Version 1.0",
     packages=find_packages(),
     provides=[PKG],
-    install_requires=['PyYaml', 'requests', 'beautifulsoup4'],
+    install_requires=['PyYaml', 'requests', 'grequests', 'beautifulsoup4'],
     test_suite='tests',
     long_description=long_desc,
     classifiers=[
         'Topic :: Internet :: WWW/HTTP',
-        'Intended Audience :: Developere',
+        'Intended Audience :: Developer',
     ]
 )
