API

aswan Package

Data collection manager

Functions

add_url_params(url, params)
get_json(url[, params])
get_soup(url[, params, browser, headless, ...])
run_simple_project(urls_for_handlers, name)

Classes

AswanDepot(name[, local_root])
BrokenSessionError
BrowserHandler()
BrowserJsonHandler()
BrowserSoupHandler()
ConnectionError
ConnectionSession(depot_path[, is_browser, ...])
ObjectStore(root[, hash_fun, compression, ...])	class for storing and retrieving objects downloaded
ParsedCollectionEvent(cev, store)
Project(name[, local_root, distributed_api, ...])
ProxyAuth(user, password)
ProxyBase()
RequestHandler()
RequestJsonHandler()
RequestSoupHandler()
Statuses()
WebExtHandler()

Class Inheritance Diagram

digraph inheritancebe73e70b4a { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Helper class that provides a standard way to create an ABC using"]; "ActorBase" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "ABC" -> "ActorBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; "AswanDepot" [URL="api/aswan.AswanDepot.html#aswan.AswanDepot",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "RemoteMixin" -> "AswanDepot" [arrowsize=0.5,style="setlinewidth(0.5)"]; "BrokenSessionError" [URL="api/aswan.BrokenSessionError.html#aswan.BrokenSessionError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "BrowserHandler" [URL="api/aswan.BrowserHandler.html#aswan.BrowserHandler",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "UrlHandlerBase" -> "BrowserHandler" [arrowsize=0.5,style="setlinewidth(0.5)"]; "BrowserJsonHandler" [URL="api/aswan.BrowserJsonHandler.html#aswan.BrowserJsonHandler",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "_JsonMixin" -> "BrowserJsonHandler" [arrowsize=0.5,style="setlinewidth(0.5)"]; "BrowserHandler" -> "BrowserJsonHandler" [arrowsize=0.5,style="setlinewidth(0.5)"]; "BrowserSoupHandler" [URL="api/aswan.BrowserSoupHandler.html#aswan.BrowserSoupHandler",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "_SoupMixin" -> "BrowserSoupHandler" [arrowsize=0.5,style="setlinewidth(0.5)"]; "BrowserHandler" -> "BrowserSoupHandler" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ConnectionError" [URL="api/aswan.ConnectionError.html#aswan.ConnectionError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "ConnectionSession" [URL="api/aswan.ConnectionSession.html#aswan.ConnectionSession",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "ActorBase" -> "ConnectionSession" [arrowsize=0.5,style="setlinewidth(0.5)"]; "DepotBase" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "ObjectStore" [URL="api/aswan.ObjectStore.html#aswan.ObjectStore",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="class for storing and retrieving objects downloaded"]; "ParsedCollectionEvent" [URL="api/aswan.ParsedCollectionEvent.html#aswan.ParsedCollectionEvent",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "Project" [URL="api/aswan.Project.html#aswan.Project",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "ProxyAuth" [URL="api/aswan.ProxyAuth.html#aswan.ProxyAuth",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="ProxyAuth(user: str, password: str)"]; "ProxyBase" [URL="api/aswan.ProxyBase.html#aswan.ProxyBase",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "RemoteMixin" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "DepotBase" -> "RemoteMixin" [arrowsize=0.5,style="setlinewidth(0.5)"]; "RequestHandler" [URL="api/aswan.RequestHandler.html#aswan.RequestHandler",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "UrlHandlerBase" -> "RequestHandler" [arrowsize=0.5,style="setlinewidth(0.5)"]; "RequestJsonHandler" [URL="api/aswan.RequestJsonHandler.html#aswan.RequestJsonHandler",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "_JsonMixin" -> "RequestJsonHandler" [arrowsize=0.5,style="setlinewidth(0.5)"]; "RequestHandler" -> "RequestJsonHandler" [arrowsize=0.5,style="setlinewidth(0.5)"]; "RequestSoupHandler" [URL="api/aswan.RequestSoupHandler.html#aswan.RequestSoupHandler",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "_SoupMixin" -> "RequestSoupHandler" [arrowsize=0.5,style="setlinewidth(0.5)"]; "RequestHandler" -> "RequestSoupHandler" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Statuses" [URL="api/aswan.Statuses.html#aswan.Statuses",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "UrlHandlerBase" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "WebExtHandler" [URL="api/aswan.WebExtHandler.html#aswan.WebExtHandler",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "UrlHandlerBase" -> "WebExtHandler" [arrowsize=0.5,style="setlinewidth(0.5)"]; "_JsonMixin" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "_SoupMixin" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; }