nv_python_libs::vimeo::vimeo_api Namespace Reference

Classes
class	VimeoException
class	CurlyRestException
class	CurlyRequest
class	SimpleOAuthClient
class	OutStreamEncoder
class	Videos
Functions
def	vimeo_albums_getAll
def	vimeo_videos_search
def	vimeo_channels_getAll
def	vimeo_channels_getVideos
def	vimeo_test_echo
def	vimeo_test_login
def	vimeo_test_null
def	vimeo_videos_upload_getQuota
def	_simple_request
def	_user_request
	User related call from the "Simple API".
def	user_info
def	user_videos
def	user_likes
def	user_appears_in
def	user_all_videos
def	user_subscriptions
def	user_albums
def	user_channels
def	user_groups
def	user_contacts_videos
def	user_contacts_like
def	video_request
	get a specific video
def	massageDescription
def	_initLogger
def	textUtf8
def	ampReplace
def	setTreeViewIcon
def	initializeVimeo
def	processVideoUrl
def	searchTitle
def	searchForVideos
def	getChannels
def	displayTreeView
def	getVideos
def	getVideosForChannels
def	getTreeVideos
Variables
string	__title__ = "vimeo_api - Simple-to-use Python interface to the vimeo API (http://vimeo.com)"
string	__author__ = "Marc Poulhiès and modified by R.D. Vaughan"
string	__purpose__
string	__version__ = "v0.2.5"
string	REQUEST_TOKEN_URL = 'http://vimeo.com/oauth/request_token'
string	ACCESS_TOKEN_URL = 'http://vimeo.com/oauth/access_token'
string	AUTHORIZATION_URL = 'http://vimeo.com/oauth/authorize'
string	API_REST_URL = 'http://vimeo.com/api/rest/v2/'
string	API_V2_CALL_URL = 'http://vimeo.com/api/v2/'
string	USER_AGENT = 'python-vimeo http://github.com/dkm/python-vimeo'
int	PORT = 80
tuple	HMAC_SHA1 = oauth.OAuthSignatureMethod_HMAC_SHA1()
	tree_dir_icon
	client
	channel
	channel_dict
	channel_count
	channel_list_max
	treeview
	tree_key
	next_page
	max_page
	tree_list
	channel_id
	dir_name

Function Documentation

def nv_python_libs::vimeo::vimeo_api::vimeo_albums_getAll	(	self,
		user_id,
		sort = `None`,
		per_page = `None`,
		page = `None`
	)

Get a list of a user's albums.
This method does not require authentication.

Definition at line 317 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::vimeo_videos_search	(	self,
		query,
		sort = `None`,
		per_page = `None`,
		page = `None`
	)

Search for matching Videos.
This method does not require authentication.

Definition at line 337 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::vimeo_channels_getAll	(	self,
		sort = `None`,
		per_page = `None`,
		page = `None`
	)

Get a list of all public channels.
This method does not require authentication.

Definition at line 362 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::vimeo_channels_getVideos	(	self,
		channel_id = `None`,
		full_response = `None`,
		per_page = `None`,
		page = `None`
	)

Get a list of Videos for a specific channels.
This method does not require authentication.

Definition at line 381 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::vimeo_test_echo	(	self,
		params = `{}`
	)

This will just repeat back any parameters that you send.
No auth required

Definition at line 431 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::vimeo_test_login ( self )

Is the user logged in?

Definition at line 443 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::vimeo_test_null ( self )

This is just a simple null/ping test.

You can use this method to make sure that you are properly
contacting to the Vimeo API.

Definition at line 450 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::vimeo_videos_upload_getQuota ( self )

(from vimeo API documentation)
Get the space and number of HD uploads left for a user.

Numbers are provided in bytes. It's a good idea to check this
method before you upload a video to let the user know if their
video will be converted to HD. hd_quota will have a value of 0
if the user reached the max number of uploads, 1
otherwise. Resets is the number of the day of the week,
starting with Sunday.

Definition at line 477 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::_simple_request	(	url,
		format
	)		`[private]`

Definition at line 494 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::_user_request	(	user,
		info,
		format
	)		`[private]`

User related call from the "Simple API".

See : http://vimeo.com/api/docs/simple-api

Definition at line 510 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::user_info	(	user,
		format = `"xml"`
	)

User info for the specified user

Definition at line 514 of file vimeo_api.py.

Referenced by setUser().

def nv_python_libs::vimeo::vimeo_api::user_videos	(	user,
		format = `"xml"`
	)

Videos created by user

Definition at line 521 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::user_likes	(	user,
		format = `"xml"`
	)

Videos the user likes

Definition at line 527 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::user_appears_in	(	user,
		format = `"xml"`
	)

Videos that the user appears in

Definition at line 533 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::user_all_videos	(	user,
		format = `"xml"`
	)

Videos that the user appears in and created

Definition at line 539 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::user_subscriptions	(	user,
		format = `"xml"`
	)

Videos the user is subscribed to

Definition at line 545 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::user_albums	(	user,
		format = `"xml"`
	)

Albums the user has created

Definition at line 551 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::user_channels	(	user,
		format = `"xml"`
	)

Channels the user has created and subscribed to

Definition at line 557 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::user_groups	(	user,
		format = `"xml"`
	)

Groups the user has created and joined

Definition at line 563 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::user_contacts_videos	(	user,
		format = `"xml"`
	)

Videos that the user's contacts created

Definition at line 569 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::user_contacts_like	(	user,
		format = `"xml"`
	)

Videos that the user's contacts like

Definition at line 575 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::video_request	(	video,
		format
	)

get a specific video

Definition at line 585 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::massageDescription	(	self,
		text
	)

Removes HTML markup from a text string.
@param text The HTML source.
@return The plain text.  If the HTML source contains non-ASCII
entities or character references, this is a Unicode string.

Definition at line 772 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::_initLogger ( self ) [private]

Setups a logger using the logging module, returns a log object

Definition at line 806 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::textUtf8	(	self,
		text
	)

Definition at line 825 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::ampReplace	(	self,
		text
	)

Replace all "&" characters with "&amp;"

Definition at line 837 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::setTreeViewIcon	(	self,
		dir_icon = `None`
	)

Check if there is a specific generic tree view icon. If not default to the channel icon.
return self.tree_dir_icon

Definition at line 845 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::initializeVimeo ( self )

Initialize acccess methods for all Vimeo API calls
raise errors if there are issues during the initalization steps
return nothing

Definition at line 868 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::processVideoUrl	(	self,
		url
	)

Definition at line 891 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::searchTitle	(	self,
		title,
		pagenumber,
		pagelen
	)

Key word video search of the vimeo.com web site
return an array of matching item dictionaries
return

Definition at line 896 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::searchForVideos	(	self,
		title,
		pagenumber
	)

Common name for a video search. Used to interface with MythTV plugin NetVision

Definition at line 1024 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::getChannels ( self )

Get the channel directory information and fill out the tree view directory structures as required
raise exceptions if the there was an issue getting Channel information or no channel data
return True if successful

Definition at line 1093 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::displayTreeView ( self )

Gather the Vimeo Groups/Channels...etc then get a max page of videos meta data in each of them
return array of directories and their video metadata

Definition at line 1165 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::getVideos	(	self,
		dir_dict,
		dictionaries
	)

Parse a list made of category lists and retrieve video meta data
return a dictionary of directory names and categories video metadata

Definition at line 1220 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::getVideosForChannels	(	self,
		method,
		dictionary
	)

Process all channel related directory videos
return dictionary of new video items

Definition at line 1255 of file vimeo_api.py.

def nv_python_libs::vimeo::vimeo_api::getTreeVideos	(	self,
		method,
		dictionaries
	)

Get the video metadata for url search
return the video dictionary of directories and their video mata data

Definition at line 1301 of file vimeo_api.py.

Variable Documentation

string nv_python_libs::vimeo::vimeo_api::__title__ = "vimeo_api - Simple-to-use Python interface to the vimeo API (http://vimeo.com)"

Definition at line 31 of file vimeo_api.py.

string nv_python_libs::vimeo::vimeo_api::__author__ = "Marc Poulhiès and modified by R.D. Vaughan"

Definition at line 32 of file vimeo_api.py.

string nv_python_libs::vimeo::vimeo_api::__purpose__

Initial value:

'''
 This python script is intended to perform a variety of utility functions to search and access text
metadata and video/image URLs from vimeo. These routines are based on the v2 api. Specifications
for this api are published at http://vimeo.com/api/docs/advanced-api
'''

Definition at line 33 of file vimeo_api.py.

string nv_python_libs::vimeo::vimeo_api::__version__ = "v0.2.5"

Definition at line 39 of file vimeo_api.py.

string nv_python_libs::vimeo::vimeo_api::REQUEST_TOKEN_URL = 'http://vimeo.com/oauth/request_token'

Definition at line 71 of file vimeo_api.py.

string nv_python_libs::vimeo::vimeo_api::ACCESS_TOKEN_URL = 'http://vimeo.com/oauth/access_token'

Definition at line 72 of file vimeo_api.py.

string nv_python_libs::vimeo::vimeo_api::AUTHORIZATION_URL = 'http://vimeo.com/oauth/authorize'

Definition at line 73 of file vimeo_api.py.

string nv_python_libs::vimeo::vimeo_api::API_REST_URL = 'http://vimeo.com/api/rest/v2/'

Definition at line 75 of file vimeo_api.py.

string nv_python_libs::vimeo::vimeo_api::API_V2_CALL_URL = 'http://vimeo.com/api/v2/'