Skip to content

API Reference

Client

Bases: BaseClient

A client that interacts with the re3data API.

Attributes:

Name Type Description
_client Client

The underlying HTTP client.
_repository_manager RepositoryManager

The repository manager to retrieve metadata from the repositories endpoints.

Examples:

>>> client = Client():
>>> response = re3data.repositories.list()
>>> print(response)
<?xml version="1.0" encoding="UTF-8"?>
<list>
<repository>
    <id>r3d100010468</id>
    <doi>https://doi.org/10.17616/R3QP53</doi>
    <name>Zenodo</name>
    <link href="https://www.re3data.org/api/beta/repository/r3d100010468" rel="self" />
</repository>
... (remaining repositories truncated)
Source code in src/re3data/_client.py 
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
class Client(BaseClient):
    """A client that interacts with the re3data API.

    Attributes:
        _client: The underlying HTTP client.
        _repository_manager: The repository manager to retrieve metadata from the repositories endpoints.

    Examples:
        >>> client = Client():
        >>> response = re3data.repositories.list()
        >>> print(response)
        <?xml version="1.0" encoding="UTF-8"?>
        <list>
        <repository>
            <id>r3d100010468</id>
            <doi>https://doi.org/10.17616/R3QP53</doi>
            <name>Zenodo</name>
            <link href="https://www.re3data.org/api/beta/repository/r3d100010468" rel="self" />
        </repository>
        ... (remaining repositories truncated)
    """

    _client: httpx.Client

    def __init__(self) -> None:
        super().__init__(httpx.Client)
        self._repository_manager: RepositoryManager = RepositoryManager(self)

    def _request(self, endpoint: str, return_type: str) -> str | httpx.Response:
        """Send a HTTP GET request to the specified endpoint.

        Args:
            endpoint: The endpoint to send the request to.
            return_type: The type of response to expect.

        Returns:
            A string representation of the response (if `return_type` is "xml") or the full response object.

        Raises:
            httpx.RequestError: If the request fails or times out.
            ValueError: If an invalid `return_type` is provided.
        """
        response = self._client.get(endpoint)
        response.raise_for_status()
        match return_type:
            case "xml":
                return response.text
            case "response":
                return response
            case _:
                raise ValueError(f"Invalid `return_type`: {return_type}. Expected one of: `xml`, `response`.")

    @property
    def repositories(self) -> RepositoryManager:
        """Get the repository manager for this client.

        Returns:
            The repository manager.
        """
        return self._repository_manager

repositories: RepositoryManager property

Get the repository manager for this client.

Returns:

Type Description
RepositoryManager

The repository manager.