API¶

The API is exposed via service wrappers, which provide convenient OAuth 1.0, 2.0, and Ofly flow methods as well as session management.

Each service type has specialized Session objects, which may be used directly.

OAuth 1.0 Services¶

class rauth.OAuth1Service(consumer_key, consumer_secret, name=None, request_token_url=None, access_token_url=None, authorize_url=None, base_url=None, session_obj=None, signature_obj=None)¶

An OAuth 1.0/a Service container.

This class provides a wrapper around a specialized Requests’ Session object. Primarily this wrapper is used to produce authenticated session objects. These may be used to make requests against OAuth 1.0/a endpoints.

You might intialize OAuth1Service something like this:

service = OAuth1Service(
           name='example',
           consumer_key='123',
           consumer_secret='456',
           request_token_url='http://example.com/request_token',
           access_token_url='http://example.com/access_token',
           authorize_url='http://example.com/authorize',
           base_url='http://example.com/api')

Now the request token should be retrieved:

request_token, request_token_secret = service.get_request_token()

Differing Request Token Formats

Some services provide different formatting when returning tokens. For this reason the service wrapper provides a special method get_raw_request_token(). This will return the unparsed response. At this point it’s up to you to extract the necessary data.

It’s time to access the authorize URI and direct the client to authorize requests on their behalf. This URI is retrieved as follows:

authorize_url = service.get_authorize_url(request_token)

Once the client has authorized the request it is now possible to retrieve an access token. Do so as follows:

session = service.get_auth_session(request_token, request_token_secret)

Differing Access Token Formats

Some services provide different formatting when returning tokens. For this reason the service wrapper provides a special method get_raw_access_token(). This will return the unparsed response. At this point it’s up to you to extract the necessary data.

Finally we have an authenticated session and are ready to make requests against OAuth 1.0/a endpoints. Because Rauth is a wrapper around Requests, the same API you would use with Requests is exposed and expected:

r = session.get('some/resource/', params={'format': 'json'})
print r.json()

Parameters:

consumer_key (str) – Client consumer key, required for signing.
consumer_secret (str) – Client consumer secret, required for signing.
name (str) – The service name, defaults to None.
request_token_url (str) – Request token endpoint, defaults to None.
access_token_url (str) – Access token endpoint, defaults to None.
authorize_url (str) – Authorize endpoint, defaults to None.
base_url (str) – A base URL from which to construct requests, defaults to None.
session_obj (Session) – Object used to construct sessions with, defaults to rauth.OAuth1Session
signature_obj (SignatureMethod) – Object used to construct signatures with, defaults to rauth.oauth.HmacSha1Signature

consumer_key = None¶: Client credentials.

get_access_token(request_token, request_token_secret, method='GET', decoder=<function parse_utf8_qsl>, key_token='oauth_token', key_token_secret='oauth_token_secret', **kwargs)¶

Returns an access token pair.

Parameters:

request_token (str) – The request token as returned by get_request_token().
request_token_secret (str) – The request token secret as returned by get_request_token().
method (str) – A string representation of the HTTP method to be used, defaults to GET.
decoder (func) – A function used to parse the Response content. Should return a dictionary.
key_token – The key the access token will be decoded by, defaults to ‘oauth_token’.
key_token_secret – The key the access token will be decoded by, defaults to ‘oauth_token_secret’.
**kwargs (dict) – Optional arguments. Same as Requests.

get_auth_session(request_token, request_token_secret, method='GET', **kwargs)¶

Gets an access token, intializes a new authenticated session with the access token. Returns an instance of session_obj.

Parameters:	request_token (str) – The request token as returned by `get_request_token()`. request_token_secret (str) – The request token secret as returned by `get_request_token()`. method (str) – A string representation of the HTTP method to be used, defaults to GET. *kwargs (dict*) – Optional arguments. Same as Requests.

get_authorize_url(request_token, **params)¶

Returns a formatted authorize URL.

Parameters:	request_token (str) – The request token as returned by `get_request_token`. *params (dict*) – Additional keyworded arguments to be added to the request querystring.

get_raw_access_token(request_token, request_token_secret, method='GET', **kwargs)¶

Returns a Requests’ response over the rauth.OAuth1Service.access_token_url.

Use this if your endpoint if you need the full Response object.

Parameters:	request_token (str) – The request token as returned by `get_request_token()`. request_token_secret (str) – The request token secret as returned by `get_request_token()`. method (str) – A string representation of the HTTP method to be used, defaults to GET. *kwargs (dict*) – Optional arguments. Same as Requests.

get_raw_request_token(method='GET', **kwargs)¶

Returns a Requests’ response over the rauth.OAuth1Service.request_token_url.

Use this if your endpoint if you need the full Response object.

Parameters:	method (str) – A string representation of the HTTP method to be used, defaults to GET. *kwargs (dict*) – Optional arguments. Same as Requests.

get_request_token(method='GET', decoder=<function parse_utf8_qsl>, key_token='oauth_token', key_token_secret='oauth_token_secret', **kwargs)¶

Return a request token pair.

Parameters:

method (str) – A string representation of the HTTP method to be used, defaults to GET.
decoder (func) – A function used to parse the Response content. Should return a dictionary.
key_token – The key the access token will be decoded by, defaults to ‘oauth_token’.
key_token_secret – The key the access token will be decoded by, defaults to ‘oauth_token_secret’.
**kwargs (dict) – Optional arguments. Same as Requests.

get_session(token=None, signature=None)¶

If provided a token parameter, tries to retrieve a stored rauth.OAuth1Session instance. Otherwise generates a new session instance with the rauth.OAuth1Service.consumer_key and rauth.OAuth1Service.consumer_secret stored on the rauth.OAuth1Service instance.

Parameters:	token (tuple) – A tuple of strings with which to memoize the session object instance.

request_token_response = None¶: Request and access token responses.

request_token_url = None¶: Authorization endpoints.

session_obj = None¶: Object used to construct sessions with.

signature_obj = None¶: Object used to construct signatures with.

OAuth 2.0 Services¶

class rauth.OAuth2Service(client_id, client_secret, name=None, access_token_url=None, authorize_url=None, base_url=None, session_obj=None)¶

An OAuth 2.0 Service container.

This class provides a wrapper around a specialized Requests’ Session object. Primarily this wrapper is used for producing authenticated session objects which are used to make requests against OAuth 2.0 endpoints.

You might intialize OAuth2Service something like this:

service = OAuth2Service(
           name='example',
           client_id='123',
           client_secret='456',
           access_token_url='https://example.com/token',
           authorize_url='https://example.com/authorize',
           base_url='https://example.com/api/')

Given the simplicity of OAuth 2.0 now this object service can be used to retrieve an authenticated session in two simple steps:

# the return URL is used to validate the request
params = {'redirect_uri': 'http://example.com/',
          'response_type': 'code'}
url = service.get_authorize_url(**params)

# once the above URL is consumed by a client we can ask for an access
# token. note that the code is retrieved from the redirect URL above,
# as set by the provider
data = {'code': 'foobar',
        'grant_type': 'authorization_code',
        'redirect_uri': 'http://example.com/'}

session = service.get_auth_session(data=data)

Now that we have retrieved a session, we may make requests against the OAuth 2.0 provider’s endpoints. As much as possible the Requests’ API is preserved and you may make requests using the same parameters you would using Requests:

r = session.get('foo', params={'format': 'json'})
print r.json()

Parameters:

client_id (str) – Client id.
client_secret (str) – Client secret.
name (str) – The service name, defaults to None.
access_token_url (str) – Access token endpoint, defaults to None.
authorize_url (str) – Authorize endpoint, defaults to None.
base_url (str) – A base URL from which to construct requests, defaults to None.
session_obj (rauth.Session) – Object used to construct sessions with, defaults to OAuth2Session

access_token_response = None¶: Access token response.

access_token_url = None¶: The provider’s access token URL.

client_id = None¶: Client credentials.

get_access_token(method='POST', decoder=<function parse_utf8_qsl>, key='access_token', **kwargs)¶

Returns an access token.

Parameters:	method (str) – A string representation of the HTTP method to be used, defaults to POST. decoder (func) – A function used to parse the Response content. Should return a dictionary. key – The key the access token will be decoded by, defaults to ‘access_token’. *kwargs (dict*) – Optional arguments. Same as Requests.

get_auth_session(method='POST', **kwargs)¶

Gets an access token, intializes a new authenticated session with the access token. Returns an instance of session_obj.

Parameters:	method (str) – A string representation of the HTTP method to be used, defaults to POST. *kwargs (dict*) – Optional arguments. Same as Requests.

get_authorize_url(**params)¶

Returns a formatted authorize URL.

Parameters:	*params (dict*) – Additional keyworded arguments to be added to the URL querystring.

get_raw_access_token(method='POST', **kwargs)¶

Returns a Requests’ response over the OAuth2Service.access_token_url.

Use this if your endpoint if you need the full Response object.

Parameters:	method (str) – A string representation of the HTTP method to be used, defaults to POST. *kwargs (dict*) – Optional arguments. Same as Requests.

get_session(token=None)¶

If provided, the token parameter is used to initialize an authenticated session, otherwise an unauthenticated session object is generated. Returns an instance of session_obj..

Parameters:	token (str) – A token with which to initilize the session.

session_obj = None¶: Object used to construct sessions with.

Ofly Services¶

class rauth.OflyService(app_id, app_secret, name=None, authorize_url=None, base_url=None, user_id=None, session_obj=None)¶

An Ofly Service container.

This class wraps an Ofly service i.e., Shutterfly. The process is similar to that of OAuth 1.0 but simplified.

You might intialize OflyService something like this:

service = OflyService(name='example',
                      app_id='123',
                      app_secret='456',
                      authorize_url='http://example.com/authorize')

A signed authorize URL is then produced via calling service.get_authorize_url. Once this has been visited by the client and assuming the client authorizes the request.

Normal API calls can now be made using a session instance. Retrieve the authenticated session like so:

session = service.get_auth_session('foo')

# now we can make regular Requests' calls
r = session.get('bar')

Parameters:

app_id (str) – The oFlyAppId, i.e. “application ID”.
app_secret (str) – The oFlyAppSecret, i.e. “shared secret”.
name (str) – The service name, defaults to None.
authorize_url (str) – Authorize endpoint, defaults to None.
base_url (str) – A base URL from which to construct requests, defaults to None.
user_id (str) – The oflyUserid, defaults to None. Note: this is required for Ofly requests, retrieved via authorize URL.
session_obj (rauth.Session) – Object used to construct sessions with, defaults to rauth.OflySession

app_id = None¶: Client credentials.

get_auth_session(user_id, **kwargs)¶

Intializes a new authenticated session with user_id as oFlyUserid. Returns an instance of session_obj.

Parameters:	user_id (str) – The oflyUserid, defaults to None. *kwargs (dict*) – Optional arguments. Same as Requests.

get_authorize_url(**params)¶

Returns a formatted authorize URL.

Parameters:	*params (dict*) – Additional keyworded arguments to be added to the request querystring.

get_session(token)¶

The token parameter should be oFlyUserid. This is used to initialize an authenticated session instance. Returns an instance of session_obj.

Parameters:	token (str) – A token with which to initialize the session with, e.g. `OflyService.user_id`.

session_obj = None¶: Object used to construct sessions with.

user_id = None¶: The oflyUserid.

OAuth 1.0 Sessions¶

class rauth.OAuth1Session(consumer_key, consumer_secret, access_token=None, access_token_secret=None, signature=None, service=None)¶

A specialized Session object, wrapping OAuth 1.0/a logic.

This object is utilized by the OAuth1Service wrapper but can be used independently of that infrastructure. Essentially this is a loose wrapping around the standard Requests codepath. State may be tracked at this layer, especially if the instance is kept around and tracked via some unique identifier, e.g. access tokens. Things like request cookies will be preserved between requests and in fact all functionality provided by a Requests’ Session object should be exposed here.

If you were to use this object by itself you could do so by instantiating it like this:

session = OAuth1Session('123',
                        '456',
                        access_token='321',
                        access_token_secret='654')

You now have a session object which can be used to make requests exactly as you would with a normal Requests’ Session instance. This anticipates that the standard OAuth 1.0/a flow will be modeled outside of the scope of this class. In other words, if the fully qualified flow is useful to you then this object probably need not be used directly, instead consider using OAuth1Service.

Once the session object is setup, you may start making requests:

r = session.get('http://example/com/api/resource',
                params={'format': 'json'})
print r.json()

Parameters:

consumer_key (str) – Client consumer key.
consumer_secret (str) – Client consumer secret.
access_token (str) – Access token, defaults to None.
access_token_secret (str) – Access token secret, defaults to None.
signature (rauth.oauth.Signature) – A signature producing object, defaults to rauth.oauth.HmacSha1Signature.
service (rauth.Service) – A back reference to the service wrapper, defaults to None.

access_token = None¶: Access token credentials.

close()¶: Closes all adapters and as such the session

consumer_key = None¶: Client credentials.

delete(url, **kwargs)¶

Sends a DELETE request. Returns Response object.

Parameters:	url – URL for the new `Request` object. **kwargs – Optional arguments that `request` takes.

get(url, **kwargs)¶

Sends a GET request. Returns Response object.

Parameters:	url – URL for the new `Request` object. **kwargs – Optional arguments that `request` takes.

get_adapter(url)¶: Returns the appropriate connnection adapter for the given URL.

head(url, **kwargs)¶

Sends a HEAD request. Returns Response object.

Parameters:	url – URL for the new `Request` object. **kwargs – Optional arguments that `request` takes.

merge_environment_settings(url, proxies, stream, verify, cert)¶: Check the environment and merge it with some settings.

mount(prefix, adapter)¶

Registers a connection adapter to a prefix.

Adapters are sorted in descending order by key length.

options(url, **kwargs)¶

Sends a OPTIONS request. Returns Response object.

Parameters:	url – URL for the new `Request` object. **kwargs – Optional arguments that `request` takes.

patch(url, data=None, **kwargs)¶

Sends a PATCH request. Returns Response object.

Parameters:	url – URL for the new `Request` object. data – (optional) Dictionary, bytes, or file-like object to send in the body of the `Request`. **kwargs – Optional arguments that `request` takes.

post(url, data=None, json=None, **kwargs)¶

Sends a POST request. Returns Response object.

Parameters:	url – URL for the new `Request` object. data – (optional) Dictionary, bytes, or file-like object to send in the body of the `Request`. json – (optional) json to send in the body of the `Request`. **kwargs – Optional arguments that `request` takes.

prepare_request(request)¶

Constructs a PreparedRequest for transmission and returns it. The PreparedRequest has settings merged from the Request instance and those of the Session.

Parameters:	request – `Request` instance to prepare with this session’s settings.

put(url, data=None, **kwargs)¶

Sends a PUT request. Returns Response object.

Parameters:	url – URL for the new `Request` object. data – (optional) Dictionary, bytes, or file-like object to send in the body of the `Request`. **kwargs – Optional arguments that `request` takes.

rebuild_auth(prepared_request, response)¶: When being redirected we may want to strip authentication from the request to avoid leaking credentials. This method intelligently removes and reapplies authentication where possible to avoid credential loss.

rebuild_proxies(prepared_request, proxies)¶

This method re-evaluates the proxy configuration by considering the environment variables. If we are redirected to a URL covered by NO_PROXY, we strip the proxy configuration. Otherwise, we set missing proxy keys for this URL (in case they were stripped by a previous redirect).

This method also replaces the Proxy-Authorization header where necessary.

request(method, url, header_auth=False, realm='', **req_kwargs)¶

A loose wrapper around Requests’ Session which injects OAuth 1.0/a parameters.

Parameters:	method (str) – A string representation of the HTTP method to be used. url (str) – The resource to be requested. header_auth (bool) – Authentication via header, defaults to False. realm (str) – The auth header realm, defaults to `""`. *req_kwargs (dict*) – Keyworded args to be passed down to Requests.

resolve_redirects(resp, req, stream=False, timeout=None, verify=True, cert=None, proxies=None, **adapter_kwargs)¶: Receives a Response. Returns a generator of Responses.

send(request, **kwargs)¶: Send a given PreparedRequest.

signature = None¶: Signing method.

OAuth 2.0 Sessions¶

class rauth.OAuth2Session(client_id=None, client_secret=None, access_token=None, service=None, access_token_key=None)¶

A specialized Session object, wrapping OAuth 2.0 logic.

This object is utilized by the OAuth2Service wrapper but can be used independently of that infrastructure. Essentially this is a loose wrapping around the standard Requests codepath. State may be tracked at this layer, especially if the instance is kept around and tracked via some unique identifier, e.g. access token. Things like request cookies will be preserved between requests and in fact all functionality provided by a Requests’ Session object should be exposed here.

If you were to use this object by itself you could do so by instantiating it like this:

session = OAuth2Session('123', '456', access_token='321')

You now have a session object which can be used to make requests exactly as you would with a normal Requests Session instance. This anticipates that the standard OAuth 2.0 flow will be modeled outside of the scope of this class. In other words, if the fully qualified flow is useful to you then this object probably need not be used directly, instead consider using OAuth2Service.

Once the session object is setup, you may start making requests:

r = session.get('https://example/com/api/resource',
                params={'format': 'json'})
print r.json()

Parameters:

client_id (str) – Client id, defaults to None.
client_secret (str) – Client secret, defaults to None
access_token (str) – Access token, defaults to None.
access_token_key (str) – The name of the access token key, defaults to ‘access_token’.
service (rauth.Service) – A back reference to the service wrapper, defaults to None.
access_token_key – The name of the access token key, defaults to ‘access_token’.

access_token = None¶: Access token.

access_token_key = None¶: Access token key, e.g. ‘access_token’.

client_id = None¶: Client credentials.

close()¶: Closes all adapters and as such the session

delete(url, **kwargs)¶

Sends a DELETE request. Returns Response object.

Parameters:	url – URL for the new `Request` object. **kwargs – Optional arguments that `request` takes.

get(url, **kwargs)¶

Sends a GET request. Returns Response object.

Parameters:	url – URL for the new `Request` object. **kwargs – Optional arguments that `request` takes.

get_adapter(url)¶: Returns the appropriate connnection adapter for the given URL.

head(url, **kwargs)¶

Sends a HEAD request. Returns Response object.

Parameters:	url – URL for the new `Request` object. **kwargs – Optional arguments that `request` takes.

merge_environment_settings(url, proxies, stream, verify, cert)¶: Check the environment and merge it with some settings.

mount(prefix, adapter)¶

Registers a connection adapter to a prefix.

Adapters are sorted in descending order by key length.

options(url, **kwargs)¶

Sends a OPTIONS request. Returns Response object.

Parameters:	url – URL for the new `Request` object. **kwargs – Optional arguments that `request` takes.

patch(url, data=None, **kwargs)¶

Sends a PATCH request. Returns Response object.

Parameters:	url – URL for the new `Request` object. data – (optional) Dictionary, bytes, or file-like object to send in the body of the `Request`. **kwargs – Optional arguments that `request` takes.

post(url, data=None, json=None, **kwargs)¶

Sends a POST request. Returns Response object.

Parameters:	url – URL for the new `Request` object. data – (optional) Dictionary, bytes, or file-like object to send in the body of the `Request`. json – (optional) json to send in the body of the `Request`. **kwargs – Optional arguments that `request` takes.

prepare_request(request)¶

Constructs a PreparedRequest for transmission and returns it. The PreparedRequest has settings merged from the Request instance and those of the Session.

Parameters:	request – `Request` instance to prepare with this session’s settings.

put(url, data=None, **kwargs)¶

Sends a PUT request. Returns Response object.

Parameters:	url – URL for the new `Request` object. data – (optional) Dictionary, bytes, or file-like object to send in the body of the `Request`. **kwargs – Optional arguments that `request` takes.

rebuild_auth(prepared_request, response)¶: When being redirected we may want to strip authentication from the request to avoid leaking credentials. This method intelligently removes and reapplies authentication where possible to avoid credential loss.

rebuild_proxies(prepared_request, proxies)¶

This method re-evaluates the proxy configuration by considering the environment variables. If we are redirected to a URL covered by NO_PROXY, we strip the proxy configuration. Otherwise, we set missing proxy keys for this URL (in case they were stripped by a previous redirect).

This method also replaces the Proxy-Authorization header where necessary.

request(method, url, bearer_auth=True, **req_kwargs)¶

A loose wrapper around Requests’ Session which injects OAuth 2.0 parameters.

Parameters:	method (str) – A string representation of the HTTP method to be used. url (str) – The resource to be requested. bearer_auth (bool) – Whether to use Bearer Authentication or not, defaults to True. *req_kwargs (dict*) – Keyworded args to be passed down to Requests.

resolve_redirects(resp, req, stream=False, timeout=None, verify=True, cert=None, proxies=None, **adapter_kwargs)¶: Receives a Response. Returns a generator of Responses.

send(request, **kwargs)¶: Send a given PreparedRequest.

Ofly Sessions¶

class rauth.OflySession(app_id, app_secret, user_id=None, service=None)¶

A specialized Session object, wrapping Ofly logic.

This object is utilized by the OflyService wrapper but can be used independently of that infrastructure. Essentially this is a loose wrapping around the standard Requests codepath. State may be tracked at this layer, especially if the instance is kept around and tracked via some unique identifier. Things like request cookies will be preserved between requests and in fact all functionality provided by a Requests’ Session object should be exposed here.

If you were to use this object by itself you could do so by instantiating it like this:

session = OflySession('123', '456')

You now have a session object which can be used to make requests exactly as you would with a normal Requests Session instance. This anticipates that the standard Ofly flow will be modeled outside of the scope of this class. In other words, if the fully qualified flow is useful to you then this object probably need not be used directly, instead consider using OflyService.

Once the session object is setup, you may start making requests:

r = session.get('https://example/com/api/resource',
                params={'format': 'json'})
print r.json()

Parameters:	app_id (str) – The oFlyAppId, i.e. “application ID”. app_secret (str) – The oFlyAppSecret, i.e. “shared secret”. service (`rauth.Service`) – A back reference to the service wrapper, defaults to None.

app_id = None¶: Client credentials.

close()¶: Closes all adapters and as such the session

delete(url, **kwargs)¶

Sends a DELETE request. Returns Response object.

Parameters:	url – URL for the new `Request` object. **kwargs – Optional arguments that `request` takes.

get(url, **kwargs)¶

Sends a GET request. Returns Response object.

Parameters:	url – URL for the new `Request` object. **kwargs – Optional arguments that `request` takes.

get_adapter(url)¶: Returns the appropriate connnection adapter for the given URL.

head(url, **kwargs)¶

Sends a HEAD request. Returns Response object.

Parameters:	url – URL for the new `Request` object. **kwargs – Optional arguments that `request` takes.

merge_environment_settings(url, proxies, stream, verify, cert)¶: Check the environment and merge it with some settings.

mount(prefix, adapter)¶

Registers a connection adapter to a prefix.

Adapters are sorted in descending order by key length.

options(url, **kwargs)¶

Sends a OPTIONS request. Returns Response object.

Parameters:	url – URL for the new `Request` object. **kwargs – Optional arguments that `request` takes.

patch(url, data=None, **kwargs)¶

Sends a PATCH request. Returns Response object.

Parameters:	url – URL for the new `Request` object. data – (optional) Dictionary, bytes, or file-like object to send in the body of the `Request`. **kwargs – Optional arguments that `request` takes.

post(url, data=None, json=None, **kwargs)¶

Sends a POST request. Returns Response object.

Parameters:	url – URL for the new `Request` object. data – (optional) Dictionary, bytes, or file-like object to send in the body of the `Request`. json – (optional) json to send in the body of the `Request`. **kwargs – Optional arguments that `request` takes.

prepare_request(request)¶

Constructs a PreparedRequest for transmission and returns it. The PreparedRequest has settings merged from the Request instance and those of the Session.

Parameters:	request – `Request` instance to prepare with this session’s settings.

put(url, data=None, **kwargs)¶

Sends a PUT request. Returns Response object.

Parameters:	url – URL for the new `Request` object. data – (optional) Dictionary, bytes, or file-like object to send in the body of the `Request`. **kwargs – Optional arguments that `request` takes.

rebuild_auth(prepared_request, response)¶: When being redirected we may want to strip authentication from the request to avoid leaking credentials. This method intelligently removes and reapplies authentication where possible to avoid credential loss.

rebuild_proxies(prepared_request, proxies)¶

This method re-evaluates the proxy configuration by considering the environment variables. If we are redirected to a URL covered by NO_PROXY, we strip the proxy configuration. Otherwise, we set missing proxy keys for this URL (in case they were stripped by a previous redirect).

This method also replaces the Proxy-Authorization header where necessary.

request(method, url, user_id=None, hash_meth='sha1', **req_kwargs)¶

A loose wrapper around Requests’ Session which injects Ofly parameters.

Parameters:	method (str) – A string representation of the HTTP method to be used. url (str) – The resource to be requested. hash_meth (str) – The hash method to use for signing, defaults to “sha1”. user_id (str) – The oflyUserid, defaults to None. *req_kwargs (dict*) – Keyworded args to be passed down to Requests.

resolve_redirects(resp, req, stream=False, timeout=None, verify=True, cert=None, proxies=None, **adapter_kwargs)¶: Receives a Response. Returns a generator of Responses.

send(request, **kwargs)¶: Send a given PreparedRequest.

static sign(url, app_id, app_secret, hash_meth='sha1', **params)¶

A signature method which generates the necessary Ofly parameters.

Parameters:	app_id (str) – The oFlyAppId, i.e. “application ID”. app_secret (str) – The oFlyAppSecret, i.e. “shared secret”. hash_meth (str) – The hash method to use for signing, defaults to “sha1”. *params (dict*) – Additional parameters.

user_id = None¶: oFlyUserid

API¶

OAuth 1.0 Services¶

OAuth 2.0 Services¶

Ofly Services¶

OAuth 1.0 Sessions¶

OAuth 2.0 Sessions¶

Ofly Sessions¶

Table Of Contents

Related Topics

This Page