WebClient

airvpn.web

An interface for interacting with the website.

WebClient

High-level entry point for interacting with the AirVPN website.

Attributes:

Name	Type	Description
user	AuthUser | None	The currently authenticated user, or None if login has not yet been called.
session	WebSession	The underlying session used for all requests.
forum	ForumManager	Entry point for browsing the site's forums.

find_member(username: str) -> list[WebUser]

Search for members by username.

Parameters:

Name	Type	Description	Default
username	str	Full or partial username to search for.	required

Returns:

Type	Description
list[WebUser]	Matching users found by the search.

login(username: Optional[str] = None, password: Optional[str] = None, remember_me: bool = False, session_key: Optional[str] = None) -> AuthUser

Authenticate with the AirVPN website.

Parameters:

Name	Type	Description	Default
username	str	Account username or email address.	None
password	str	Account password.	None
remember_me	bool	Store the session credentials in keyring.	False
session_key	str	Session key from AuthUser.get_sesion_key().	None

Returns:

Type	Description
AuthUser	The authenticated user, also stored on self.user.

Raises:

Type	Description
LoginError	If authentication fails.