1.0.0

See HISTORY.rst for change details!

Author: michaelhelmick

HISTORY.rst

@@ -0,0 +1,20 @@
+.. :changelog:
+
+History
+-------
+
+1.0.0 (2013-05-23)
+++++++++++++++++++
+
+- Changed internal Tumblpy API structure, but Tumblpy functions should still work as they did before
+- Updated README with more clear examples
+- Added LICENSE
+- ``_split_params_and_files`` has been moved to ``helpers.py``
+- All ``Tumblpy`` exceptions are found in ``exceptions.py``
+- Removed ``pool_maxsize`` from ``Tumblpy.__init__`` because it wasn't being used
+- Removed ``timeout`` parameter from all request methods for the time being
+- Removed ``TumblpyTimeout`` Exception
+- Moved ``callback_url`` parameter from ``Tumblpy.__init__`` to ``get_authentication_tokens``
+- All authentication and API calls over HTTPS
+- Dropped Python 2.5 support
+- Full, transparent Python 3.3 support

LICENSE

@@ -0,0 +1,9 @@
+Copyright (c) 2013, Mike Helmick
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

MANIFEST.in

@@ -1 +1 @@
-include README.rst
+include README.rst HISTORY.rst LICENSE

README.rst

@@ -1,6 +1,8 @@
 Tumblpy
 =======
 
+.. image:: https://pypip.in/d/python-tumblpy/badge.png
+        :target: https://crate.io/packages/python-tumblpy/
 
 Tumblpy is a Python library to help interface with `Tumblr v2 REST API <http://www.tumblr.com/docs/en/api/v2>`_ & OAuth
 
@@ -14,12 +16,14 @@ Features
    - Edit/delete/reblog posts
    - And many more!!
 * Photo Uploading
+* Transparent *Python 3* Support!
 
 
 Installation
 ------------
 
-Installing Tumbply is simple: ::
+Installing Tumbply is simple:
+::
 
     $ pip install python-tumblpy
 
@@ -31,54 +35,33 @@ Authorization URL
 ~~~~~~~~~~~~~~~~~
 ::
 
-    # Without a dynamic callback url
-    # This will use the callback url specified in your app
-
-    # Go to http://www.tumblr.com/oauth/apps and click your
-    # app to find out your dynamic callback url
-    t = Tumblpy(app_key = '*your app key*',
-                app_secret = '*your app secret*')
-
-If you wish to have a dynamic callback url, specify ``callback_url`` when you initiate the class.
-
-::
+    t = Tumblpy(YOUR_CONSUMER_KEY, YOUR_CONSUMER_SECRET)
 
-    t = Tumblpy(app_key = '*your app key*',
-            app_secret = '*your app secret*',
-            callback_url = 'http://example.com/callback/')
-
-::
-
-    auth_props = t.get_authentication_tokens()
+    auth_props = t.get_authentication_tokens(callback_url='http://michaelhelmick.com')
     auth_url = auth_props['auth_url']
+
+    OAUTH_TOKEN_SECRET = auth_props['oauth_token_secret']
     
-    oauth_token = auth_props['oauth_token']
-    oauth_token_secret = auth_props['oauth_token_secret']
-    
-    Connect with Tumblr via: % auth_url
+    print 'Connect with Tumblr via: %s' % auth_url
 
 Once you click "Allow" be sure that there is a URL set up to handle getting finalized tokens and possibly adding them to your database to use their information at a later date.
 
 Handling the Callback
 ~~~~~~~~~~~~~~~~~~~~~
 ::
 
-    # oauth_token and oauth_token_secret come from the previous step
+    # OAUTH_TOKEN_SECRET comes from the previous step
     # if needed, store those in a session variable or something
 
-    t = Tumblpy(app_key = '*your app key*',
-            app_secret = '*your app secret*',
-            oauth_token=oauth_token,
-            oauth_token_secret=oauth_token_secret)
-
+    # oauth_verifier and OAUTH_TOKEN are found in your callback url querystring
     # In Django, you'd do something like
+    # OAUTH_TOKEN = request.GET.get('oauth_token')
     # oauth_verifier = request.GET.get('oauth_verifier')
-    
-    # or get the oauth_verifier by visiting auth_url in a browser
-    # after you authorize the app you'll be redirected to a page (your oauth_callback or Tumblr's 404)
-    # grab the oauth_verifier from the url of that page
 
-    oauth_verifier = *Grab oauth verifier from URL*
+
+    t = Tumblpy(YOUR_CONSUMER_KEY, YOUR CONSUMER_SECRET,
+                OAUTH_TOKEN, OAUTH_TOKEN_SECRET)
+
     authorized_tokens = t.get_authorized_tokens(oauth_verifier)
     
     final_oauth_token = authorized_tokens['oauth_token']
@@ -92,28 +75,13 @@ Getting some User information
 
     # Get the final tokens from the database or wherever you have them stored
 
-    t = Tumblpy(app_key = '*your app key*',
-                app_secret = '*your app secret*',
-                oauth_token=final_tokens['oauth_token'],
-                oauth_token_secret=final_tokens['oauth_token_secret'])
+    t = Tumblpy(YOUR_CONSUMER_KEY, YOUR CONSUMER_SECRET,
+                OAUTH_TOKEN, OAUTH_TOKEN_SECRET)
 
     # Print out the user info, let's get the first blog url...
     blog_url = t.post('user/info')
     blog_url = blog_url['user']['blogs'][0]['url']
 
-Get a User Avatar URL (No need for authentication for this method)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-::
-
-    t = Tumblpy()
-    avatar = t.get_avatar_url(blog_url='omglegit.tumblr.com', size=128)
-    print avatar['url']
-
-    # OR
-
-    avatar = t.get('avatar', blog_url='omglegit.tumblr.com'. extra_endpoints=['128'])
-    print avatar['url']
-
 Getting posts from a certain blog
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 ::
@@ -171,11 +139,24 @@ Following a user
 
     # Assume you are using the blog_url and Tumblpy instance from the previous sections
     try:
-        follow = t.post('user/follow', params={'url': 'omglegit.tumblr.com'})
+        follow = t.post('user/follow', params={'url': 'tumblpy.tumblr.com'})
     except TumblpyError:
         # if the url given in params is not valid,
         # Tumblr will respond with a 404 and Tumblpy will raise a TumblpyError
 
+Get a User Avatar URL *(No need for authentication for this method)*
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+::
+
+    t = Tumblpy()
+    avatar = t.get_avatar_url(blog_url='tumblpy.tumblr.com', size=128)
+    print avatar['url']
+
+    # OR
+
+    avatar = t.get('avatar', blog_url='tumblpy.tumblr.com', extra_endpoints=['128'])
+    print avatar['url']
+
 Catching errors
 ~~~~~~~~~~~~~~~
 ::

setup.py

@@ -2,19 +2,31 @@
 
 from setuptools import setup
 
+import os
+import sys
+
+__author__ = 'Mike Helmick <[email protected]>'
+__version__ = '1.0.0'
+
+if sys.argv[-1] == 'publish':
+    os.system('python setup.py sdist upload')
+    sys.exit()
+
 setup(
     name='python-tumblpy',
-    version='0.7.1',
-    install_requires=['requests>=1.0.4,<1.1.0', 'simplejson', 'requests_oauthlib'],
+    version='1.0.0',
+    install_requires=['requests==1.2.2', 'requests_oauthlib==0.3.2'],
     author='Mike Helmick',
     author_email='[email protected]',
-    license='MIT License',
+    license=open('LICENSE').read(),
     url='https://github.com/michaelhelmick/python-tumblpy/',
     keywords='python tumblpy tumblr oauth api',
     description='A Python Library to interface with Tumblr v2 REST API & OAuth',
-    long_description=open('README.rst').read(),
-    download_url="https://github.com/michaelhelmick/python-tumblpy/zipball/master",
-    py_modules=["tumblpy"],
+    long_description=open('README.rst').read() + '\n\n' +
+                     open('HISTORY.rst').read(),
+    download_url='https://github.com/michaelhelmick/python-tumblpy/zipball/master',
+    include_package_data=True,
+    packages=['tumblpy'],
     classifiers=[
         'Development Status :: 4 - Beta',
         'Intended Audience :: Developers',
@@ -23,7 +35,4 @@
         'Topic :: Communications :: Chat',
         'Topic :: Internet'
     ],
-    dependency_links=[
-        'https://github.com/requests/requests-oauthlib/tarball/master#egg=requests_oauthlib-0.2.0'
-    ],
 )