Skip to content

API Docs

An example project.

Example

An example class

Source code in example/__init__.py 
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
class Example():
    """ An example class """

    def __init__(self, username:str, password:str):
        """ Stores the data. """

        self.username = username
        self.password = password

    def login(self):
        """ Logs in to the system. """
        pass

__init__(username, password)

Stores the data.

Source code in example/__init__.py 
 6
 7
 8
 9
10
def __init__(self, username:str, password:str):
    """ Stores the data. """

    self.username = username
    self.password = password

login()

Logs in to the system.

Source code in example/__init__.py 
12
13
14
def login(self):
    """ Logs in to the system. """
    pass