Module datatap.api.endpoints

Encapsulates all of the raw API requests.

In most cases, it is preferable to interact with the api through the datatap.api.entities submodule. However, this module can be used as well.

from datatap.api.endpoints import ApiEndpoints

api_endpoints = ApiEndpoints()

print(api_endpoints.user.current())
print(api_endpoints.database.list())
Expand source code
"""
Encapsulates all of the raw API requests.

In most cases, it is preferable to interact with the api through the
`datatap.api.entities` submodule. However, this module can be used
as well.

```py
from datatap.api.endpoints import ApiEndpoints

api_endpoints = ApiEndpoints()

print(api_endpoints.user.current())
print(api_endpoints.database.list())
```
"""

from .endpoints import ApiEndpoints

__all__ = [
    "ApiEndpoints"
]

Sub-modules

datatap.api.endpoints.database_endpoints
datatap.api.endpoints.dataset_endpoints
datatap.api.endpoints.endpoints
datatap.api.endpoints.repository_endpoints
datatap.api.endpoints.request
datatap.api.endpoints.user_endpoints

Classes

class ApiEndpoints (api_key: Optional[str] = None, uri: Optional[str] = None)

Class for performing raw API requests.

Expand source code
class ApiEndpoints:
    """
    Class for performing raw API requests.
    """

    user: User
    """
    User endpoints.
    """

    database: Database
    """
    Database endpoints.
    """

    repository: Repository
    """
    Repository endpoints.
    """

    dataset: Dataset
    """
    Dataset endpoints.
    """

    _request: Request

    def __init__(self, api_key: Optional[str] = None, uri: Optional[str] = None):
        self._request = Request(api_key, uri)

        self.user = User(self._request)
        self.database = Database(self._request)
        self.repository = Repository(self._request)
        self.dataset = Dataset(self._request)

Class variables

var databaseDatabase

Database endpoints.

var datasetDataset

Dataset endpoints.

var repositoryRepository

Repository endpoints.

var userUser

User endpoints.