Merge pull request Imgur#33 from RandomInsano/breakout_code_examples

jasdev · jasdev · commit 5b2ec09179e5 · 2015-03-05T09:50:09.000-08:00
Break out code examples
diff --git a/.gitignore b/.gitignore
@@ -5,4 +5,5 @@ config.json
 dist
 build
 imgurpython.egg-info
-runner.py
+runner.py
+examples/auth.ini
diff --git a/examples/auth.ini b/examples/auth.ini
@@ -0,0 +1,4 @@
+[credentials]
+client_id=YOUR ID HERE
+client_secret=YOUR SECRET HERE
+refresh_token=
diff --git a/examples/auth.py b/examples/auth.py
@@ -0,0 +1,41 @@
+#!/usr/bin/env python3
+
+'''
+	Here's how you go about authenticating yourself! The important thing to
+	note here is that this script will be used in the other examples so
+	set up a test user with API credentials and set them up in auth.ini.
+'''
+
+from imgurpython import ImgurClient
+from helpers import get_input, get_config
+
+def authenticate():
+	# Get client ID and secret from auth.ini
+	config = get_config()
+	config.read('auth.ini')
+	client_id = config['credentials']['client_id']
+	client_secret = config['credentials']['client_secret']
+
+	client = ImgurClient(client_id, client_secret)
+
+	# Authorization flow, pin example (see docs for other auth types)
+	authorization_url = client.get_auth_url('pin')
+
+	print("Go to the following URL: {0}".format(authorization_url))
+
+	# Read in the pin, handle Python 2 or 3 here.
+	pin = get_input("Enter pin code: ")
+
+	# ... redirect user to `authorization_url`, obtain pin (or code or token) ...
+	credentials = client.authorize(pin, 'pin')
+	client.set_user_auth(credentials['access_token'], credentials['refresh_token'])
+
+	print("Authentication successful! Here are the details:")
+	print("   Access token:  {0}".format(credentials['access_token']))
+	print("   Refresh token: {0}".format(credentials['refresh_token']))
+
+	return client
+
+# If you want to run this as a standalone script, so be it!
+if __name__ == "__main__":
+	authenticate()
diff --git a/examples/helpers.py b/examples/helpers.py
@@ -0,0 +1,20 @@
+'''
+	These functions have nothing to do with the API, they just help ease
+	issues between Python 2 and 3
+'''
+
+def get_input(string):
+	''' Get input from console regardless of python 2 or 3 '''
+	try:
+		return raw_input(string)
+	except:
+		return input(string)
+
+def get_config():
+	''' Create a config parser for reading INI files '''
+	try:
+		import ConfigParser
+		return ConfigParser.ConfigParser()
+	except:
+		import configparser
+		return configparser.ConfigParser()
diff --git a/examples/upload.py b/examples/upload.py
@@ -0,0 +1,47 @@
+#!/usr/bin/env python3
+
+'''
+	Here's how you upload an image. For this example, put the cutest picture
+	of a kitten you can find in this script's folder and name it 'Kitten.jpg'
+
+	For more details about images and the API see here:
+		https://api.imgur.com/endpoints/image
+'''
+
+# Pull authentication from the auth example (see auth.py)
+from auth import authenticate
+
+from datetime import datetime
+
+album = None # You can also enter an album ID here
+image_path = 'Kitten.jpg'
+
+def upload_kitten(client):
+	'''
+		Upload a picture of a kitten. We don't ship one, so get creative!
+	'''
+
+	# Here's the metadata for the upload. All of these are optional, including
+	# this config dict itself.
+	config = {
+		'album': album,
+		'name':  'Catastrophe!',
+		'title': 'Catastrophe!',
+		'description': 'Cute kitten being cute on {0}'.format(datetime.now())
+	}
+
+	print("Uploading image... ")
+	image = client.upload_from_path(image_path, config=config, anon=False)
+	print("Done")
+	print()
+
+	return image
+
+
+# If you want to run this as a standalone script
+if __name__ == "__main__":
+	client = authenticate()
+	image = upload_kitten(client)
+
+	print("Image was posted! Go check your images you sexy beast!")
+	print("You can find it here: {0}".format(image['link']))
