Skip to content

Credentials

Credentials for authenticating with the server.

Source code in q3as/client.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
class Credentials:
    """
    Credentials for authenticating with the server.
    """

    id: str
    secret: str

    def __init__(self, id: str, secret: str):
        """
        Create a new credentials instance.
        """
        self.id = id
        self.secret = secret

    @classmethod
    def load(cls, file: str | IOBase):
        """
        Load credentials from a file.
        """
        if isinstance(file, str):
            file = open(file)
        return cls(**json.load(file))

    def auth(self):
        return BasicAuth(self.id, self.secret)

__init__(id, secret)

Create a new credentials instance.

Source code in q3as/client.py 
28
29
30
31
32
33
def __init__(self, id: str, secret: str):
    """
    Create a new credentials instance.
    """
    self.id = id
    self.secret = secret

load(file) classmethod

Load credentials from a file.

Source code in q3as/client.py 
35
36
37
38
39
40
41
42
@classmethod
def load(cls, file: str | IOBase):
    """
    Load credentials from a file.
    """
    if isinstance(file, str):
        file = open(file)
    return cls(**json.load(file))