Skip to content

Connection ​

Skapi ​

python
from skapi import Skapi

skapi = Skapi(project_id: str, *, storage=None, timeout: float = 120, encryption=None)
argument
project_idthe Project ID from your project's Settings page on skapi.com
storagewhere the signed-in session is kept: None (memory, this object only), a file path (a JSON file created readable by you only), or an object with get_item(key), set_item(key, value), remove_item(key)
timeoutseconds to wait for each request
encryptionTrue or options: encrypts the data of private records before upload. Needs pip install "skapi[encryption]". See Encryption.

Attributes: project_id, service, owner, version ("2.4.0"), user (the signed-in profile or None), session (tokens: .id_token.jwt_token, .access_token.jwt_token, .refresh_token), connection (the last connection info from the server).

Errors ​

codemessage
INVALID_PARAMETERProject ID is required. / Project ID is invalid.
NOT_SUPPORTEDRecord encryption needs the "cryptography" package: pip install "skapi[encryption]"
NOT_EXISTSThe project ID does not exist. Create your project from skapi.com (raised by the first call)

get_connection_info ​

python
skapi.get_connection_info(refresh: bool = False) -> dict

The project's name and settings, and the caller as the server sees it. refresh=True asks the server again instead of using the answer from the first call.

python
{
    "project_id": "...",
    "service_name": "My Project",
    "user_ip": "203.0.113.7",
    "user_agent": "Python-urllib/3.12",
    "user_location": "KR",
    "version": "2.4.0",
    "conf": {"prevent_signup": False, "require_login": False, "anonymous_login": False, ...},
    "encryption_recovery": {"code": None, "message": "..."},   # only with encryption on and a signed-in user
}

"encryption_recovery" holds the user's encryption recovery code on the first call after it was created (their first password login with encryption on), and None after that, with a "message" saying what to do. See Encryption recovery codes.

skapi-py 2.4.0