Lever¶

class leveropen.lever.Lever(access_token: Optional[str] = None, base_url: str = 'https://www.leveropen.com/api/', version: str = 'v1')¶

Parameters

access_token (str) – Personal Access Token for Lever Open
base_url (str) – host url for Lever Open API e.g. 'https://www.leveropen.com/api/'
version (str) – Lever Open API version e.g. 'v1'

Variables

client – (leveropen.client.Client()) Lever Open API Client

Example

from leveropen import Lever

access_token = 'your-unique-personal-access-token'
lever = Lever(access_token)

get_all_datasets() → List[leveropen.dataset.Dataset]¶

All Lever Open datasets

Note

This method takes a long time to complete, therefore it is recommended to use one of the specific methods to get a specific dataset (or datasets specific to a Topic/Collection):

leveropen.lever.Lever.get_datasets_by_topic()
leveropen.lever.Lever.get_datasets_by_collection()
leveropen.lever.Lever.get_datasets_by_name()

Returns: list of all Lever Open datasets
Return type: List[Dataset]
Example

>>> self.get_all_datasets()
[
    Dataset(
        uuid='example-uuid-1',
        name='Example dataset 1',
        released_on=datetime.datetime(2021, 2, 11, 0, 0),
        processed_on=datetime.datetime(2021, 3, 3, 0, 0),
        collection='Example Collection',
        ...
    ),
    Dataset(
        uuid='example-uuid-2',
        name='Example dataset 2',
        released_on=datetime.datetime(2021, 2, 11, 0, 0),
        processed_on=datetime.datetime(2021, 3, 3, 0, 0),
        collection='Example Collection',
        ...
    ),
    ...
]

get_datasets_by_collection(collection: str) → List[leveropen.dataset.Dataset]¶

Returns: list of datasets
Return type: List[Dataset]
Example

>>> self.get_datasets_by_collection(collection='Example Collection')
[Dataset(
    uuid='example-uuid',
    name='Example dataset',
    released_on=datetime.datetime(2021, 2, 11, 0, 0),
    processed_on=datetime.datetime(2021, 3, 3, 0, 0),
    collection='Example Collection',
    ...
)]

get_datasets_by_name(name: str) → List[leveropen.dataset.Dataset]¶

Returns: list of datasets
Return type: List[Dataset]
Example

>>> self.get_datasets_by_name(name='Example dataset')
[Dataset(
    uuid='example-uuid',
    name='Example dataset',
    released_on=datetime.datetime(2021, 2, 11, 0, 0),
    processed_on=datetime.datetime(2021, 3, 3, 0, 0),
    collection='Example Collection',
    ...
)]

get_datasets_by_topic(topic: str) → List[leveropen.dataset.Dataset]¶

Returns: list of datasets
Return type: List[Dataset]
Example

>>> self.get_datasets_by_topic(topic='Example Topic')
[Dataset(
    uuid='example-uuid',
    name='Example dataset',
    released_on=datetime.datetime(2021, 2, 11, 0, 0),
    processed_on=datetime.datetime(2021, 3, 3, 0, 0),
    collection='Example Collection',
    topic='Example Topic',
    ...
)]