PyDocuShare API Reference

This is the top page of PyDocuShare API Reference

The tables below or the left pane include the links to API documents of individual classes and functions.

It is recommended to see Getting Started for typical usage of this API.

Functions

handle(handle_str)	Utility function to convert a handle string to a canonical instance.
join_url(*args)	Construct a full URL by combining a base URL with other URLs.

Classes

DocuShare(base_url)	This class represents a session to access a DocuShare site.
Resource(value)	This enum represents one DocuShare resource.
PasswordOption(value)	Option for password prompting.
DocuShareSystemError(error_code, ...)	Raised if the DocuShare site encounters a system error.
DocuShareNotFoundError(docushare, url)	Raised if the object does not exist in the DocuShare site.
DocuShareNotAuthorizedError(docushare, url)	Raised if it is not authorized to access a DocuShare URL.
DocuShareBaseObject(docushare, hdl)	Represents one object in DocuShare.
FileObject(docushare, hdl, title, filename)	Represents one file object in DocuShare.
DocumentObject(docushare, hdl, title, ...)	Represents one Document object in DocuShare.
VersionObject(docushare, hdl, title, ...)	Represents one Version object in DocuShare.
CollectionObject(docushare, hdl, title, ...)	Represents one Collection object in DocuShare.
CollectionDownloadOption(value)	Represents a Collection download option.
Handle(handle_type, handle_number)	This class represents a DocuShare handle.
HandleNode(handle_type, handle_number)	This class represents a DocuShare handle in a tree structure.
CollectionHandleNode(handle_number[, children])	This class represents a DocuShare Collection handle in a tree structure.
DocumentHandleNode(handle_number)	This class represents a DocuShare Document handle in a tree structure.
HandleType(value)	Represents a DocuShare handle type.
InvalidHandleError(invalid_handle_str)	Indicates an invalid DocuShare handle.
DocuShareParseError(docushare, url, cause)	Raised if parsing one of DocuShare web page fails.