Main BB classic app module¶
- / - Main Page Handler
- /login - Login Page Handler
- /logout - Logout Page Handler
- /api/.* - Cross Domain Handler
- class bb.CacheInfo(parent=None, key_name=None, _app=None, _from_entity=False, **kwds)[source]¶
Model for the cached response.
Attributes:
- url - Fetch URL
- status_code - Response status
- headers - Response headers
- content - Response content
- date - Date when response was added to the cache
- class bb.CrossDomain(request=None, response=None)[source]¶
Cross Domain Handler
- PUT /api/.* - CrossDomain PUT
- POST /api/.* - CrossDomain POST
- DELETE /api/.* - CrossDomain DELETE
- GET /api/.* - CrossDomain GET
- class bb.LoginPage(request=None, response=None)[source]¶
Login Page Handler
- GET /login - LoginPage GET
- POST /login - LoginPage POST
- class bb.LogoutPage(request=None, response=None)[source]¶
Logout Page Handler
- GET /logout - LogoutPage GET
- class bb.MainPage(request=None, response=None)[source]¶
Main Page Handler
- GET / - MainPage GET
- bb.absolute_url(subdomain, relative_url='', params='', query='', fragment='')[source]¶
Prepare absolute url for request
Parameters: - subdomain (string) – [required] basecamphq subdomain
- relative_url (string) – relative url
- params (string) – url parameters
- query (string) – url query
- fragment (string) – url fragment
Returns: absolute url for request
Return type: string
- bb.convert(node)[source]¶
convert xml to dict
Parameters: node (string) – [required] xml node to convert Returns: converted node Raises: Exception Return type: tuple(string, valuetype)
- bb.convertchilds(childs)[source]¶
convert childs
Parameters: childs (list) – [required] list of nodes Returns: converted childs Raises: Exception Return type: list
- bb.convertsubnodes(childs)[source]¶
convert subnodes
Parameters: childs (list) – [required] list of nodes Returns: converted nodes Raises: Exception Return type: dict|string
- bb.dict2xml(data, tags)[source]¶
convert dict to xml
Parameters: - data (dict) – [required] dict with data to convert
- tags (tuple) – [required] tuple of base tags
Returns: pretty xml
Return type: string
- bb.get_headers(username, password)[source]¶
Prepare request headers
Parameters: - username (string) – [required] username
- password (string) – [required] password
Returns: headers dict
Return type: dict
- bb.get_subject_id(username, password, subdomain)[source]¶
Get ‘subject_id’ for report query - it is id of logged in user.
Parameters: - username (string) – [required] username
- password (string) – [required] password
- subdomain (string) – [required] subdomain
Returns: id of logged in user
Raises: Return type: string