citric._rest¶
LimeSurvey REST API client.
Submodules¶
Classes¶
LimeSurvey REST API client. |
Package Contents¶
- class citric._rest.RESTClient(url, username, password, *, requests_session=None)[source]¶
LimeSurvey REST API client.
Upon creation, retrieves a session ID that’s used for authentication.
Warning
The REST API is still in early development, so the client is subject to changes.
- Parameters:
url (str) – LimeSurvey server URL. For example,
http://www.yourdomain.com/rest/v1
.username (str) – LimeSurvey user name.
password (str) – LimeSurvey password.
requests_session (requests.Session | None) – A
requests.Session
object.
Added in version NEXT_VERSION.
- _auth(request)[source]¶
Authenticate with the REST API.
This is an auth callable for
requests.Session.auth
.- Parameters:
request (requests.PreparedRequest) – Prepared request.
- Returns:
The prepared request with the
Authorization
header set.- Return type:
- make_request(method, path, *, params=None, json=None)[source]¶
Make a request to the REST API.
- Parameters:
- Returns:
Response.
- Return type:
- __enter__()[source]¶
Context manager for REST session.
- Returns:
LimeSurvey REST client.
- Return type:
Self
- __exit__(exc_type, exc_value, traceback)[source]¶
Safely exit a REST session.
- Parameters:
exc_type (type[BaseException] | None) – Exception class.
exc_value (BaseException | None) – Exception instance.
traceback (types.TracebackType | None) – Error traceback.