An unoffical client library for accessing Prolific API for researchers.
Generated with https://github.com/openapi-generators/openapi-python-client from https://docs.prolific.com/docs/api-docs/public-openapi.
First, create a client:
from pyrolific import Client
client = Client(base_url="https://api.prolific.com")
If the endpoints you're going to hit require authentication, use AuthenticatedClient
instead:
from pyrolific import AuthenticatedClient
client = AuthenticatedClient(base_url="https://https://api.prolific.com", token="SuperSecretToken")
AuthenticatedClient doen't seem to work with the api, you still have to include an authorization kwarg on endpoint calls.
from pyrolific.api.studies import get_api_v1_studies
get_api_v1_studies.sync(client=client, authorization='Token SuperSecretToken')
Remainder of document unmodified autogenerated output from generator
Or do the same thing with an async version:
from pyrolific.models import MyDataModel
from pyrolific.api.my_tag import get_my_data_model
from pyrolific.types import Response
my_data: MyDataModel = await get_my_data_model.asyncio(client=client)
response: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client)
By default, when you're calling an HTTPS API it will attempt to verify that SSL is working correctly. Using certificate verification is highly recommended most of the time, but sometimes you may need to authenticate to a server (especially an internal server) using a custom certificate bundle.
client = AuthenticatedClient(
base_url="https://internal_api.example.com",
token="SuperSecretToken",
verify_ssl="/path/to/certificate_bundle.pem",
)
You can also disable certificate validation altogether, but beware that this is a security risk.
client = AuthenticatedClient(
base_url="https://internal_api.example.com",
token="SuperSecretToken",
verify_ssl=False
)
There are more settings on the generated Client
class which let you control more runtime behavior, check out the docstring on that class for more info.
Things to know:
Every path/method combo becomes a Python module with four functions:
sync
: Blocking request that returns parsed data (if successful) or None
sync_detailed
: Blocking request that always returns a Request
, optionally with parsed
set if the request was successful.asyncio
: Like sync
but async instead of blockingasyncio_detailed
: Like sync_detailed
but async instead of blockingAll path/query params, and bodies become method arguments.
If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)
Any endpoint which did not have a tag will be in pyrolific.api.default
This project uses Poetry to manage dependencies and packaging. Here are the basics:
poetry config repositories.<your-repository-name> <url-to-your-repository>
poetry config http-basic.<your-repository-name> <username> <password>
poetry publish --build -r <your-repository-name>
or, if for public PyPI, just poetry publish --build
If you want to install this client into another project without publishing it (e.g. for development) then:
poetry add <path-to-this-client>
from that projectpoetry build -f wheel
pip install <path-to-wheel>