pynssp.core package¶
Submodules¶
pynssp.core.constants module¶
pynssp.core.container module¶
- class pynssp.core.container.APIGraph(path, response)[source]¶
Bases:
objectA class to store an API graph
- Parameters:
path – a string representing the location of a graph
response – an object of class response
- Variables:
path – the location of a graph file
response – a response object
- class pynssp.core.container.NSSPContainer(value)[source]¶
Bases:
objectA NSSPContainer Class to store a value or an object
An object of class NSSPContainer stores a value or an object The NSSPContainer class encapsulates a value or an object
- Parameters:
value – value to store
- Variables:
value – Stored value
- Examples:
>>> from pynssp import NSSPContainer >>> >>> cont = NSSPContainer("abcdef")
pynssp.core.credentials module¶
- class pynssp.core.credentials.Credentials(username=None, password=None)[source]¶
Bases:
AuthA Token Class Representing a Credentials object
A Credentials object has a username, a password and a key. A Credentials object gets API data via an API URL.
- Parameters:
username – a string for username (Default username = None)
password – a string for password (Default password = None)
- Examples:
>>> from pynssp import Credentials >>> >>> myProfile = Credentials("user", "pass")
pynssp.core.token module¶
- class pynssp.core.token.Token(token, access_token='Bearer')[source]¶
Bases:
AuthA Token Class Representing a Token object
A Token object has a token string and a key. A Token object can get API data via an API URL.
- Parameters:
token – a token string
access_token – type of HTTP authentication. Should be “Bearer” or “Basic”. (Default value = “Bearer”)
- Variables:
access_token – HTTP authentication type.
- Examples:
>>> from pynssp import Token >>> >>> myTokenProfile = Token("abc123")