Public Member Functions
def	__init__
def	get_request_token
def	get_authorize_token_url
def	get_access_token
def	vimeo_oauth_checkAccessToken
def	vimeo_albums_getAll
	Album section.
def	vimeo_videos_search
	Video section.
def	vimeo_channels_getAll
	Channel section.
def	vimeo_channels_getVideos
def	vimeo_test_echo
	Contacts section.
def	vimeo_test_login
def	vimeo_test_null
def	vimeo_videos_upload_getQuota
	Videos section.
Public Attributes
	curly
	key
	secret
	server
	port
	request_token_url
	access_token_url
	authorization_url
	consumer
	token
Private Member Functions
def	_fetch_token
def	_do_vimeo_authenticated_call
def	_do_vimeo_unauthenticated_call

Detailed Description

Class used for handling authenticated call to the API.

Definition at line 204 of file vimeo_api.py.

Constructor & Destructor Documentation

def nv_python_libs.vimeo.vimeo_api.SimpleOAuthClient.__init__	(	self,
		key,
		secret,
		server = `"vimeo.com"`,
		port = `PORT`,
		request_token_url = `REQUEST_TOKEN_URL`,
		access_token_url = `ACCESS_TOKEN_URL`,
		authorization_url = `AUTHORIZATION_URL`,
		token = `None`,
		token_secret = `None`
	)

You need to give both key (consumer key) and secret (consumer secret).
If you already have an access token (token+secret), you can use it
by giving it through token and token_secret parameters.
If not, then you need to call both get_request_token(), get_authorize_token_url() and
finally get_access_token().

Definition at line 209 of file vimeo_api.py.

Member Function Documentation

def nv_python_libs.vimeo.vimeo_api.SimpleOAuthClient.get_request_token ( self )

Requests a request token and return it on success.

Definition at line 239 of file vimeo_api.py.

def nv_python_libs.vimeo.vimeo_api.SimpleOAuthClient.get_authorize_token_url ( self )

Returns a URL used to verify and authorize the application to access
user's account. The pointed page should contain a simple 'password' that
acts as the 'verifier' in oauth.

Definition at line 249 of file vimeo_api.py.

def nv_python_libs.vimeo.vimeo_api.SimpleOAuthClient.get_access_token	(	self,
		verifier
	)

Should be called after having received the 'verifier' from the authorization page.
See 'get_authorize_token_url()' method.

Definition at line 261 of file vimeo_api.py.

def nv_python_libs.vimeo.vimeo_api.SimpleOAuthClient._fetch_token	(	self,
		oauth_request
	)	`[private]`

Sends a requests and interprets the result as a token string.

Definition at line 275 of file vimeo_api.py.

Referenced by nv_python_libs.vimeo.vimeo_api.SimpleOAuthClient.get_access_token(), and nv_python_libs.vimeo.vimeo_api.SimpleOAuthClient.get_request_token().

def nv_python_libs.vimeo.vimeo_api.SimpleOAuthClient.vimeo_oauth_checkAccessToken	(	self,
		auth_token
	)

Definition at line 282 of file vimeo_api.py.

def nv_python_libs.vimeo.vimeo_api.SimpleOAuthClient._do_vimeo_authenticated_call	(	self,
		method,
		parameters = `{}`
	)	`[private]`

Wrapper to send an authenticated call to vimeo. You first need to have
an access token.

Definition at line 286 of file vimeo_api.py.

Referenced by nv_python_libs.vimeo.vimeo_api.SimpleOAuthClient.vimeo_test_login(), nv_python_libs.vimeo.vimeo_api.SimpleOAuthClient.vimeo_test_null(), and nv_python_libs.vimeo.vimeo_api.SimpleOAuthClient.vimeo_videos_upload_getQuota().

def nv_python_libs.vimeo.vimeo_api.SimpleOAuthClient._do_vimeo_unauthenticated_call	(	self,
		method,
		parameters = `{}`
	)	`[private]`

Wrapper to send an unauthenticated call to vimeo. You don't need to have
an access token.

Definition at line 301 of file vimeo_api.py.

Referenced by nv_python_libs.vimeo.vimeo_api.SimpleOAuthClient.vimeo_albums_getAll(), nv_python_libs.vimeo.vimeo_api.SimpleOAuthClient.vimeo_channels_getAll(), nv_python_libs.vimeo.vimeo_api.SimpleOAuthClient.vimeo_channels_getVideos(), nv_python_libs.vimeo.vimeo_api.SimpleOAuthClient.vimeo_test_echo(), and nv_python_libs.vimeo.vimeo_api.SimpleOAuthClient.vimeo_videos_search().

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

Album section.

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.SimpleOAuthClient.vimeo_videos_search	(	self,
		query,
		sort = `None`,
		per_page = `None`,
		page = `None`
	)

Video section.

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.SimpleOAuthClient.vimeo_channels_getAll	(	self,
		sort = `None`,
		per_page = `None`,
		page = `None`
	)

Channel section.

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.SimpleOAuthClient.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.SimpleOAuthClient.vimeo_test_echo	(	self,
		params = `{}`
	)

Contacts section.

Groups section Groups Events section Groups forums section OAuth section People section Test section

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.SimpleOAuthClient.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.SimpleOAuthClient.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.SimpleOAuthClient.vimeo_videos_upload_getQuota ( self )

Videos section.

Videos comments section Videos embed section Videos Upload section

(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.