| Name | meitner JSON |
| Version |
0.0.4
JSON |
| download |
| home_page | None |
| Summary | Python Client SDK Generated by Speakeasy. |
| upload_time | 2025-10-08 07:39:36 |
| maintainer | None |
| docs_url | None |
| author | Speakeasy |
| requires_python | >=3.9.2 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# meitner
Developer-friendly & type-safe Python SDK specifically catered to leverage *meitner* API.
<div align="left">
<a href="https://www.speakeasy.com/?utm_source=meitner&utm_campaign=python"><img src="https://www.speakeasy.com/assets/badges/built-by-speakeasy.svg" /></a>
<a href="https://opensource.org/licenses/MIT">
<img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
</a>
</div>
<br /><br />
> [!IMPORTANT]
> This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/meitner-2u8/api). Delete this section before > publishing to a package manager.
<!-- Start Summary [summary] -->
## Summary
Directory API: Generated API documentation
<!-- End Summary [summary] -->
<!-- Start Table of Contents [toc] -->
## Table of Contents
<!-- $toc-max-depth=2 -->
* [meitner](https://github.com/meitner-se/api-client-python/blob/master/#meitner)
* [SDK Installation](https://github.com/meitner-se/api-client-python/blob/master/#sdk-installation)
* [IDE Support](https://github.com/meitner-se/api-client-python/blob/master/#ide-support)
* [SDK Example Usage](https://github.com/meitner-se/api-client-python/blob/master/#sdk-example-usage)
* [Authentication](https://github.com/meitner-se/api-client-python/blob/master/#authentication)
* [Available Resources and Operations](https://github.com/meitner-se/api-client-python/blob/master/#available-resources-and-operations)
* [Pagination](https://github.com/meitner-se/api-client-python/blob/master/#pagination)
* [Retries](https://github.com/meitner-se/api-client-python/blob/master/#retries)
* [Error Handling](https://github.com/meitner-se/api-client-python/blob/master/#error-handling)
* [Server Selection](https://github.com/meitner-se/api-client-python/blob/master/#server-selection)
* [Custom HTTP Client](https://github.com/meitner-se/api-client-python/blob/master/#custom-http-client)
* [Resource Management](https://github.com/meitner-se/api-client-python/blob/master/#resource-management)
* [Debugging](https://github.com/meitner-se/api-client-python/blob/master/#debugging)
* [Development](https://github.com/meitner-se/api-client-python/blob/master/#development)
* [Maturity](https://github.com/meitner-se/api-client-python/blob/master/#maturity)
* [Contributions](https://github.com/meitner-se/api-client-python/blob/master/#contributions)
<!-- End Table of Contents [toc] -->
<!-- Start SDK Installation [installation] -->
## SDK Installation
> [!NOTE]
> **Python version upgrade policy**
>
> Once a Python version reaches its [official end of life date](https://devguide.python.org/versions/), a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.
The SDK can be installed with *uv*, *pip*, or *poetry* package managers.
### uv
*uv* is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.
```bash
uv add meitner
```
### PIP
*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
```bash
pip install meitner
```
### Poetry
*Poetry* is a modern tool that simplifies dependency management and package publishing by using a single `pyproject.toml` file to handle project metadata and dependencies.
```bash
poetry add meitner
```
### Shell and script usage with `uv`
You can use this SDK in a Python shell with [uv](https://docs.astral.sh/uv/) and the `uvx` command that comes with it like so:
```shell
uvx --from meitner python
```
It's also possible to write a standalone Python script without needing to set up a whole project like so:
```python
#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.9"
# dependencies = [
# "meitner",
# ]
# ///
from meitner import Meitner
sdk = Meitner(
# SDK arguments
)
# Rest of script here...
```
Once that is saved to a file, you can run it with `uv run script.py` where
`script.py` can be replaced with the actual file name.
<!-- End SDK Installation [installation] -->
<!-- Start IDE Support [idesupport] -->
## IDE Support
### PyCharm
Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.
- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)
<!-- End IDE Support [idesupport] -->
<!-- Start SDK Example Usage [usage] -->
## SDK Example Usage
### Example
```python
# Synchronous Example
from meitner import Meitner, models
import os
with Meitner(
security=models.Security(
client_credentials=os.getenv("MEITNER_CLIENT_CREDENTIALS", ""),
client_secret=os.getenv("MEITNER_CLIENT_SECRET", ""),
),
) as m_client:
res = m_client.schools.list(limit=1, offset=0)
while res is not None:
# Handle items
res = res.next()
```
</br>
The same SDK client can also be used to make asynchronous requests by importing asyncio.
```python
# Asynchronous Example
import asyncio
from meitner import Meitner, models
import os
async def main():
async with Meitner(
security=models.Security(
client_credentials=os.getenv("MEITNER_CLIENT_CREDENTIALS", ""),
client_secret=os.getenv("MEITNER_CLIENT_SECRET", ""),
),
) as m_client:
res = await m_client.schools.list_async(limit=1, offset=0)
while res is not None:
# Handle items
res = res.next()
asyncio.run(main())
```
<!-- End SDK Example Usage [usage] -->
<!-- Start Authentication [security] -->
## Authentication
### Per-Client Security Schemes
This SDK supports the following security schemes globally:
| Name | Type | Scheme | Environment Variable |
| -------------------- | ------ | ------- | ---------------------------- |
| `client_credentials` | apiKey | API key | `MEITNER_CLIENT_CREDENTIALS` |
| `client_secret` | apiKey | API key | `MEITNER_CLIENT_SECRET` |
You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:
```python
from meitner import Meitner, models
import os
with Meitner(
security=models.Security(
client_credentials=os.getenv("MEITNER_CLIENT_CREDENTIALS", ""),
client_secret=os.getenv("MEITNER_CLIENT_SECRET", ""),
),
) as m_client:
res = m_client.schools.list(limit=1, offset=0)
while res is not None:
# Handle items
res = res.next()
```
<!-- End Authentication [security] -->
<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations
<details open>
<summary>Available methods</summary>
### [audit_events](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/auditevents/README.md)
* [list](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/auditevents/README.md#list) - List AuditEvents
* [search](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/auditevents/README.md#search) - Search AuditEvents
* [get](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/auditevents/README.md#get) - Get a AuditEvent
### [employee_placements](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/employeeplacements/README.md)
* [list](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/employeeplacements/README.md#list) - List EmployeePlacements
* [create](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/employeeplacements/README.md#create) - Create a new EmployeePlacement
* [search](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/employeeplacements/README.md#search) - Search EmployeePlacements
* [get](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/employeeplacements/README.md#get) - Get a EmployeePlacement
* [delete](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/employeeplacements/README.md#delete) - Delete a EmployeePlacement
* [update](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/employeeplacements/README.md#update) - Update a EmployeePlacement
### [employees](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/employees/README.md)
* [list](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/employees/README.md#list) - List Employees
* [create](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/employees/README.md#create) - Create a new Employee
* [search](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/employees/README.md#search) - Search Employees
* [get](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/employees/README.md#get) - Get a Employee
* [delete](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/employees/README.md#delete) - Delete a Employee
* [update](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/employees/README.md#update) - Update a Employee
### [groups](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/groups/README.md)
* [list](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/groups/README.md#list) - List Groups
* [create](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/groups/README.md#create) - Create a new Group
* [search](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/groups/README.md#search) - Search Groups
* [get](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/groups/README.md#get) - Get a Group
* [delete](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/groups/README.md#delete) - Delete a Group
* [update](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/groups/README.md#update) - Update a Group
### [guardians](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/guardians/README.md)
* [list](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/guardians/README.md#list) - List Guardians
* [create](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/guardians/README.md#create) - Create a new Guardian
* [search](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/guardians/README.md#search) - Search Guardians
* [get](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/guardians/README.md#get) - Get a Guardian
* [delete](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/guardians/README.md#delete) - Delete a Guardian
* [update](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/guardians/README.md#update) - Update a Guardian
### [schools](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/schools/README.md)
* [list](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/schools/README.md#list) - List Schools
* [create](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/schools/README.md#create) - Create a new School
* [search](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/schools/README.md#search) - Search Schools
* [get](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/schools/README.md#get) - Get a School
* [update](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/schools/README.md#update) - Update a School
### [student_placements](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/studentplacements/README.md)
* [list](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/studentplacements/README.md#list) - List StudentPlacements
* [create](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/studentplacements/README.md#create) - Create a new StudentPlacement
* [search](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/studentplacements/README.md#search) - Search StudentPlacements
* [get](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/studentplacements/README.md#get) - Get a StudentPlacement
* [delete](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/studentplacements/README.md#delete) - Delete a StudentPlacement
* [update](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/studentplacements/README.md#update) - Update a StudentPlacement
* [archive](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/studentplacements/README.md#archive) - Archive a student placement
* [restore](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/studentplacements/README.md#restore) - Restore an archived student placement
### [students](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/students/README.md)
* [list](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/students/README.md#list) - List Students
* [create](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/students/README.md#create) - Create a new Student
* [search](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/students/README.md#search) - Search Students
* [get](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/students/README.md#get) - Get a Student
* [delete](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/students/README.md#delete) - Delete a Student
* [update](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/students/README.md#update) - Update a Student
</details>
<!-- End Available Resources and Operations [operations] -->
<!-- Start Pagination [pagination] -->
## Pagination
Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the
returned response object will have a `Next` method that can be called to pull down the next group of results. If the
return value of `Next` is `None`, then there are no more pages to be fetched.
Here's an example of one such pagination call:
```python
from meitner import Meitner, models
import os
with Meitner(
security=models.Security(
client_credentials=os.getenv("MEITNER_CLIENT_CREDENTIALS", ""),
client_secret=os.getenv("MEITNER_CLIENT_SECRET", ""),
),
) as m_client:
res = m_client.schools.list(limit=1, offset=0)
while res is not None:
# Handle items
res = res.next()
```
<!-- End Pagination [pagination] -->
<!-- Start Retries [retries] -->
## Retries
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
```python
from meitner import Meitner, models
from meitner.utils import BackoffStrategy, RetryConfig
import os
with Meitner(
security=models.Security(
client_credentials=os.getenv("MEITNER_CLIENT_CREDENTIALS", ""),
client_secret=os.getenv("MEITNER_CLIENT_SECRET", ""),
),
) as m_client:
res = m_client.schools.list(limit=1, offset=0,
RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
while res is not None:
# Handle items
res = res.next()
```
If you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:
```python
from meitner import Meitner, models
from meitner.utils import BackoffStrategy, RetryConfig
import os
with Meitner(
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
security=models.Security(
client_credentials=os.getenv("MEITNER_CLIENT_CREDENTIALS", ""),
client_secret=os.getenv("MEITNER_CLIENT_SECRET", ""),
),
) as m_client:
res = m_client.schools.list(limit=1, offset=0)
while res is not None:
# Handle items
res = res.next()
```
<!-- End Retries [retries] -->
<!-- Start Error Handling [errors] -->
## Error Handling
[`MeitnerError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/meitnererror.py) is the base class for all HTTP error responses. It has the following properties:
| Property | Type | Description |
| ------------------ | ---------------- | --------------------------------------------------------------------------------------- |
| `err.message` | `str` | Error message |
| `err.status_code` | `int` | HTTP response status code eg `404` |
| `err.headers` | `httpx.Headers` | HTTP response headers |
| `err.body` | `str` | HTTP body. Can be empty string if no body is returned. |
| `err.raw_response` | `httpx.Response` | Raw HTTP response |
| `err.data` | | Optional. Some errors may contain structured data. [See Error Classes](https://github.com/meitner-se/api-client-python/blob/master/#error-classes). |
### Example
```python
from meitner import Meitner, errors, models
import os
with Meitner(
security=models.Security(
client_credentials=os.getenv("MEITNER_CLIENT_CREDENTIALS", ""),
client_secret=os.getenv("MEITNER_CLIENT_SECRET", ""),
),
) as m_client:
res = None
try:
res = m_client.schools.list(limit=1, offset=0)
while res is not None:
# Handle items
res = res.next()
except errors.MeitnerError as e:
# The base class for HTTP error responses
print(e.message)
print(e.status_code)
print(e.body)
print(e.headers)
print(e.raw_response)
# Depending on the method different errors may be thrown
if isinstance(e, errors.Error400ResponseBody):
print(e.data.error) # models.Error400ResponseBodyError
```
### Error Classes
**Primary errors:**
* [`MeitnerError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/meitnererror.py): The base class for HTTP error responses.
* [`Error400ResponseBody`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/error400responsebody.py): Bad Request - The request was malformed or contained invalid parameters. Status code `400`.
* [`Error401ResponseBody`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/error401responsebody.py): Unauthorized - The request is missing valid authentication credentials. Status code `401`.
* [`Error403ResponseBody`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/error403responsebody.py): Forbidden - Request is authenticated, but the user is not allowed to perform the operation. Status code `403`.
* [`Error404ResponseBody`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/error404responsebody.py): Not Found - The requested resource does not exist. Status code `404`.
* [`Error409ResponseBody`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/error409responsebody.py): Conflict - The request could not be completed due to a conflict. Status code `409`.
* [`Error429ResponseBody`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/error429responsebody.py): Too Many Requests - When the rate limit has been exceeded. Status code `429`.
* [`Error500ResponseBody`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/error500responsebody.py): Internal Server Error - An unexpected server error occurred. Status code `500`.
<details><summary>Less common errors (27)</summary>
<br />
**Network errors:**
* [`httpx.RequestError`](https://www.python-httpx.org/exceptions/#httpx.RequestError): Base class for request errors.
* [`httpx.ConnectError`](https://www.python-httpx.org/exceptions/#httpx.ConnectError): HTTP client was unable to make a request to a server.
* [`httpx.TimeoutException`](https://www.python-httpx.org/exceptions/#httpx.TimeoutException): HTTP request timed out.
**Inherit from [`MeitnerError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/meitnererror.py)**:
* [`SchoolCreate422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/schoolcreate422responsebodyerror.py): Validation error for School Create operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*
* [`SchoolSearch422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/schoolsearch422responsebodyerror.py): Validation error for School Search operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*
* [`SchoolUpdate422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/schoolupdate422responsebodyerror.py): Validation error for School Update operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*
* [`GroupCreate422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/groupcreate422responsebodyerror.py): Validation error for Group Create operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*
* [`GroupSearch422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/groupsearch422responsebodyerror.py): Validation error for Group Search operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*
* [`GroupUpdate422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/groupupdate422responsebodyerror.py): Validation error for Group Update operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*
* [`EmployeeCreate422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/employeecreate422responsebodyerror.py): Validation error for Employee Create operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*
* [`EmployeeSearch422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/employeesearch422responsebodyerror.py): Validation error for Employee Search operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*
* [`EmployeeUpdate422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/employeeupdate422responsebodyerror.py): Validation error for Employee Update operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*
* [`EmployeePlacementCreate422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/employeeplacementcreate422responsebodyerror.py): Validation error for EmployeePlacement Create operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*
* [`EmployeePlacementSearch422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/employeeplacementsearch422responsebodyerror.py): Validation error for EmployeePlacement Search operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*
* [`EmployeePlacementUpdate422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/employeeplacementupdate422responsebodyerror.py): Validation error for EmployeePlacement Update operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*
* [`GuardianCreate422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/guardiancreate422responsebodyerror.py): Validation error for Guardian Create operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*
* [`GuardianSearch422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/guardiansearch422responsebodyerror.py): Validation error for Guardian Search operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*
* [`GuardianUpdate422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/guardianupdate422responsebodyerror.py): Validation error for Guardian Update operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*
* [`StudentCreate422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/studentcreate422responsebodyerror.py): Validation error for Student Create operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*
* [`StudentSearch422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/studentsearch422responsebodyerror.py): Validation error for Student Search operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*
* [`StudentUpdate422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/studentupdate422responsebodyerror.py): Validation error for Student Update operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*
* [`StudentPlacementCreate422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/studentplacementcreate422responsebodyerror.py): Validation error for StudentPlacement Create operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*
* [`StudentPlacementSearch422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/studentplacementsearch422responsebodyerror.py): Validation error for StudentPlacement Search operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*
* [`StudentPlacementUpdate422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/studentplacementupdate422responsebodyerror.py): Validation error for StudentPlacement Update operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*
* [`AuditEventSearch422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/auditeventsearch422responsebodyerror.py): Validation error for AuditEvent Search operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*
* [`ResponseValidationError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute.
</details>
\* Check [the method documentation](https://github.com/meitner-se/api-client-python/blob/master/#available-resources-and-operations) to see if the error is applicable.
<!-- End Error Handling [errors] -->
<!-- Start Server Selection [server] -->
## Server Selection
### Select Server by Name
You can override the default server globally by passing a server name to the `server: str` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:
| Name | Server | Description |
| ------------ | --------------------------------------------- | ----------------------------------------------- |
| `production` | `https://api.meitner.se/directory/v1` | Server to use in production |
| `staging` | `https://api.staging.meitner.se/directory/v1` | Server to use when building and testing the API |
#### Example
```python
from meitner import Meitner, models
import os
with Meitner(
server="staging",
security=models.Security(
client_credentials=os.getenv("MEITNER_CLIENT_CREDENTIALS", ""),
client_secret=os.getenv("MEITNER_CLIENT_SECRET", ""),
),
) as m_client:
res = m_client.schools.list(limit=1, offset=0)
while res is not None:
# Handle items
res = res.next()
```
### Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
```python
from meitner import Meitner, models
import os
with Meitner(
server_url="https://api.meitner.se/directory/v1",
security=models.Security(
client_credentials=os.getenv("MEITNER_CLIENT_CREDENTIALS", ""),
client_secret=os.getenv("MEITNER_CLIENT_SECRET", ""),
),
) as m_client:
res = m_client.schools.list(limit=1, offset=0)
while res is not None:
# Handle items
res = res.next()
```
<!-- End Server Selection [server] -->
<!-- Start Custom HTTP Client [http-client] -->
## Custom HTTP Client
The Python SDK makes API calls using the [httpx](https://www.python-httpx.org/) HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance.
Depending on whether you are using the sync or async version of the SDK, you can pass an instance of `HttpClient` or `AsyncHttpClient` respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls.
This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of `httpx.Client` or `httpx.AsyncClient` directly.
For example, you could specify a header for every request that this sdk makes as follows:
```python
from meitner import Meitner
import httpx
http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = Meitner(client=http_client)
```
or you could wrap the client with your own custom logic:
```python
from meitner import Meitner
from meitner.httpclient import AsyncHttpClient
import httpx
class CustomClient(AsyncHttpClient):
client: AsyncHttpClient
def __init__(self, client: AsyncHttpClient):
self.client = client
async def send(
self,
request: httpx.Request,
*,
stream: bool = False,
auth: Union[
httpx._types.AuthTypes, httpx._client.UseClientDefault, None
] = httpx.USE_CLIENT_DEFAULT,
follow_redirects: Union[
bool, httpx._client.UseClientDefault
] = httpx.USE_CLIENT_DEFAULT,
) -> httpx.Response:
request.headers["Client-Level-Header"] = "added by client"
return await self.client.send(
request, stream=stream, auth=auth, follow_redirects=follow_redirects
)
def build_request(
self,
method: str,
url: httpx._types.URLTypes,
*,
content: Optional[httpx._types.RequestContent] = None,
data: Optional[httpx._types.RequestData] = None,
files: Optional[httpx._types.RequestFiles] = None,
json: Optional[Any] = None,
params: Optional[httpx._types.QueryParamTypes] = None,
headers: Optional[httpx._types.HeaderTypes] = None,
cookies: Optional[httpx._types.CookieTypes] = None,
timeout: Union[
httpx._types.TimeoutTypes, httpx._client.UseClientDefault
] = httpx.USE_CLIENT_DEFAULT,
extensions: Optional[httpx._types.RequestExtensions] = None,
) -> httpx.Request:
return self.client.build_request(
method,
url,
content=content,
data=data,
files=files,
json=json,
params=params,
headers=headers,
cookies=cookies,
timeout=timeout,
extensions=extensions,
)
s = Meitner(async_client=CustomClient(httpx.AsyncClient()))
```
<!-- End Custom HTTP Client [http-client] -->
<!-- Start Resource Management [resource-management] -->
## Resource Management
The `Meitner` class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a [context manager][context-manager] and reuse it across the application.
[context-manager]: https://docs.python.org/3/reference/datamodel.html#context-managers
```python
from meitner import Meitner, models
import os
def main():
with Meitner(
security=models.Security(
client_credentials=os.getenv("MEITNER_CLIENT_CREDENTIALS", ""),
client_secret=os.getenv("MEITNER_CLIENT_SECRET", ""),
),
) as m_client:
# Rest of application here...
# Or when using async:
async def amain():
async with Meitner(
security=models.Security(
client_credentials=os.getenv("MEITNER_CLIENT_CREDENTIALS", ""),
client_secret=os.getenv("MEITNER_CLIENT_SECRET", ""),
),
) as m_client:
# Rest of application here...
```
<!-- End Resource Management [resource-management] -->
<!-- Start Debugging [debug] -->
## Debugging
You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass your own logger class directly into your SDK.
```python
from meitner import Meitner
import logging
logging.basicConfig(level=logging.DEBUG)
s = Meitner(debug_logger=logging.getLogger("meitner"))
```
You can also enable a default debug logger by setting an environment variable `MEITNER_DEBUG` to true.
<!-- End Debugging [debug] -->
<!-- Placeholder for Future Speakeasy SDK Sections -->
# Development
## Maturity
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
looking for the latest version.
## Contributions
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation.
We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=meitner&utm_campaign=python)
Raw data
{
"_id": null,
"home_page": null,
"name": "meitner",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9.2",
"maintainer_email": null,
"keywords": null,
"author": "Speakeasy",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/08/bc/46234c05c18be3200eb3f7418bf94d89358b34aefb7aaef2c6d2e63946be/meitner-0.0.4.tar.gz",
"platform": null,
"description": "# meitner\n\nDeveloper-friendly & type-safe Python SDK specifically catered to leverage *meitner* API.\n\n<div align=\"left\">\n <a href=\"https://www.speakeasy.com/?utm_source=meitner&utm_campaign=python\"><img src=\"https://www.speakeasy.com/assets/badges/built-by-speakeasy.svg\" /></a>\n <a href=\"https://opensource.org/licenses/MIT\">\n <img src=\"https://img.shields.io/badge/License-MIT-blue.svg\" style=\"width: 100px; height: 28px;\" />\n </a>\n</div>\n\n\n<br /><br />\n> [!IMPORTANT]\n> This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/meitner-2u8/api). Delete this section before > publishing to a package manager.\n\n<!-- Start Summary [summary] -->\n## Summary\n\nDirectory API: Generated API documentation\n<!-- End Summary [summary] -->\n\n<!-- Start Table of Contents [toc] -->\n## Table of Contents\n<!-- $toc-max-depth=2 -->\n* [meitner](https://github.com/meitner-se/api-client-python/blob/master/#meitner)\n * [SDK Installation](https://github.com/meitner-se/api-client-python/blob/master/#sdk-installation)\n * [IDE Support](https://github.com/meitner-se/api-client-python/blob/master/#ide-support)\n * [SDK Example Usage](https://github.com/meitner-se/api-client-python/blob/master/#sdk-example-usage)\n * [Authentication](https://github.com/meitner-se/api-client-python/blob/master/#authentication)\n * [Available Resources and Operations](https://github.com/meitner-se/api-client-python/blob/master/#available-resources-and-operations)\n * [Pagination](https://github.com/meitner-se/api-client-python/blob/master/#pagination)\n * [Retries](https://github.com/meitner-se/api-client-python/blob/master/#retries)\n * [Error Handling](https://github.com/meitner-se/api-client-python/blob/master/#error-handling)\n * [Server Selection](https://github.com/meitner-se/api-client-python/blob/master/#server-selection)\n * [Custom HTTP Client](https://github.com/meitner-se/api-client-python/blob/master/#custom-http-client)\n * [Resource Management](https://github.com/meitner-se/api-client-python/blob/master/#resource-management)\n * [Debugging](https://github.com/meitner-se/api-client-python/blob/master/#debugging)\n* [Development](https://github.com/meitner-se/api-client-python/blob/master/#development)\n * [Maturity](https://github.com/meitner-se/api-client-python/blob/master/#maturity)\n * [Contributions](https://github.com/meitner-se/api-client-python/blob/master/#contributions)\n\n<!-- End Table of Contents [toc] -->\n\n<!-- Start SDK Installation [installation] -->\n## SDK Installation\n\n> [!NOTE]\n> **Python version upgrade policy**\n>\n> Once a Python version reaches its [official end of life date](https://devguide.python.org/versions/), a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.\n\nThe SDK can be installed with *uv*, *pip*, or *poetry* package managers.\n\n### uv\n\n*uv* is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.\n\n```bash\nuv add meitner\n```\n\n### PIP\n\n*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.\n\n```bash\npip install meitner\n```\n\n### Poetry\n\n*Poetry* is a modern tool that simplifies dependency management and package publishing by using a single `pyproject.toml` file to handle project metadata and dependencies.\n\n```bash\npoetry add meitner\n```\n\n### Shell and script usage with `uv`\n\nYou can use this SDK in a Python shell with [uv](https://docs.astral.sh/uv/) and the `uvx` command that comes with it like so:\n\n```shell\nuvx --from meitner python\n```\n\nIt's also possible to write a standalone Python script without needing to set up a whole project like so:\n\n```python\n#!/usr/bin/env -S uv run --script\n# /// script\n# requires-python = \">=3.9\"\n# dependencies = [\n# \"meitner\",\n# ]\n# ///\n\nfrom meitner import Meitner\n\nsdk = Meitner(\n # SDK arguments\n)\n\n# Rest of script here...\n```\n\nOnce that is saved to a file, you can run it with `uv run script.py` where\n`script.py` can be replaced with the actual file name.\n<!-- End SDK Installation [installation] -->\n\n<!-- Start IDE Support [idesupport] -->\n## IDE Support\n\n### PyCharm\n\nGenerally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.\n\n- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)\n<!-- End IDE Support [idesupport] -->\n\n<!-- Start SDK Example Usage [usage] -->\n## SDK Example Usage\n\n### Example\n\n```python\n# Synchronous Example\nfrom meitner import Meitner, models\nimport os\n\n\nwith Meitner(\n security=models.Security(\n client_credentials=os.getenv(\"MEITNER_CLIENT_CREDENTIALS\", \"\"),\n client_secret=os.getenv(\"MEITNER_CLIENT_SECRET\", \"\"),\n ),\n) as m_client:\n\n res = m_client.schools.list(limit=1, offset=0)\n\n while res is not None:\n # Handle items\n\n res = res.next()\n```\n\n</br>\n\nThe same SDK client can also be used to make asynchronous requests by importing asyncio.\n\n```python\n# Asynchronous Example\nimport asyncio\nfrom meitner import Meitner, models\nimport os\n\nasync def main():\n\n async with Meitner(\n security=models.Security(\n client_credentials=os.getenv(\"MEITNER_CLIENT_CREDENTIALS\", \"\"),\n client_secret=os.getenv(\"MEITNER_CLIENT_SECRET\", \"\"),\n ),\n ) as m_client:\n\n res = await m_client.schools.list_async(limit=1, offset=0)\n\n while res is not None:\n # Handle items\n\n res = res.next()\n\nasyncio.run(main())\n```\n<!-- End SDK Example Usage [usage] -->\n\n<!-- Start Authentication [security] -->\n## Authentication\n\n### Per-Client Security Schemes\n\nThis SDK supports the following security schemes globally:\n\n| Name | Type | Scheme | Environment Variable |\n| -------------------- | ------ | ------- | ---------------------------- |\n| `client_credentials` | apiKey | API key | `MEITNER_CLIENT_CREDENTIALS` |\n| `client_secret` | apiKey | API key | `MEITNER_CLIENT_SECRET` |\n\nYou can set the security parameters through the `security` optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:\n```python\nfrom meitner import Meitner, models\nimport os\n\n\nwith Meitner(\n security=models.Security(\n client_credentials=os.getenv(\"MEITNER_CLIENT_CREDENTIALS\", \"\"),\n client_secret=os.getenv(\"MEITNER_CLIENT_SECRET\", \"\"),\n ),\n) as m_client:\n\n res = m_client.schools.list(limit=1, offset=0)\n\n while res is not None:\n # Handle items\n\n res = res.next()\n\n```\n<!-- End Authentication [security] -->\n\n<!-- Start Available Resources and Operations [operations] -->\n## Available Resources and Operations\n\n<details open>\n<summary>Available methods</summary>\n\n### [audit_events](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/auditevents/README.md)\n\n* [list](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/auditevents/README.md#list) - List AuditEvents\n* [search](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/auditevents/README.md#search) - Search AuditEvents\n* [get](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/auditevents/README.md#get) - Get a AuditEvent\n\n### [employee_placements](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/employeeplacements/README.md)\n\n* [list](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/employeeplacements/README.md#list) - List EmployeePlacements\n* [create](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/employeeplacements/README.md#create) - Create a new EmployeePlacement\n* [search](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/employeeplacements/README.md#search) - Search EmployeePlacements\n* [get](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/employeeplacements/README.md#get) - Get a EmployeePlacement\n* [delete](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/employeeplacements/README.md#delete) - Delete a EmployeePlacement\n* [update](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/employeeplacements/README.md#update) - Update a EmployeePlacement\n\n### [employees](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/employees/README.md)\n\n* [list](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/employees/README.md#list) - List Employees\n* [create](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/employees/README.md#create) - Create a new Employee\n* [search](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/employees/README.md#search) - Search Employees\n* [get](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/employees/README.md#get) - Get a Employee\n* [delete](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/employees/README.md#delete) - Delete a Employee\n* [update](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/employees/README.md#update) - Update a Employee\n\n### [groups](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/groups/README.md)\n\n* [list](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/groups/README.md#list) - List Groups\n* [create](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/groups/README.md#create) - Create a new Group\n* [search](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/groups/README.md#search) - Search Groups\n* [get](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/groups/README.md#get) - Get a Group\n* [delete](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/groups/README.md#delete) - Delete a Group\n* [update](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/groups/README.md#update) - Update a Group\n\n### [guardians](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/guardians/README.md)\n\n* [list](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/guardians/README.md#list) - List Guardians\n* [create](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/guardians/README.md#create) - Create a new Guardian\n* [search](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/guardians/README.md#search) - Search Guardians\n* [get](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/guardians/README.md#get) - Get a Guardian\n* [delete](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/guardians/README.md#delete) - Delete a Guardian\n* [update](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/guardians/README.md#update) - Update a Guardian\n\n### [schools](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/schools/README.md)\n\n* [list](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/schools/README.md#list) - List Schools\n* [create](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/schools/README.md#create) - Create a new School\n* [search](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/schools/README.md#search) - Search Schools\n* [get](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/schools/README.md#get) - Get a School\n* [update](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/schools/README.md#update) - Update a School\n\n### [student_placements](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/studentplacements/README.md)\n\n* [list](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/studentplacements/README.md#list) - List StudentPlacements\n* [create](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/studentplacements/README.md#create) - Create a new StudentPlacement\n* [search](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/studentplacements/README.md#search) - Search StudentPlacements\n* [get](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/studentplacements/README.md#get) - Get a StudentPlacement\n* [delete](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/studentplacements/README.md#delete) - Delete a StudentPlacement\n* [update](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/studentplacements/README.md#update) - Update a StudentPlacement\n* [archive](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/studentplacements/README.md#archive) - Archive a student placement\n* [restore](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/studentplacements/README.md#restore) - Restore an archived student placement\n\n### [students](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/students/README.md)\n\n* [list](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/students/README.md#list) - List Students\n* [create](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/students/README.md#create) - Create a new Student\n* [search](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/students/README.md#search) - Search Students\n* [get](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/students/README.md#get) - Get a Student\n* [delete](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/students/README.md#delete) - Delete a Student\n* [update](https://github.com/meitner-se/api-client-python/blob/master/docs/sdks/students/README.md#update) - Update a Student\n\n</details>\n<!-- End Available Resources and Operations [operations] -->\n\n<!-- Start Pagination [pagination] -->\n## Pagination\n\nSome of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the\nreturned response object will have a `Next` method that can be called to pull down the next group of results. If the\nreturn value of `Next` is `None`, then there are no more pages to be fetched.\n\nHere's an example of one such pagination call:\n```python\nfrom meitner import Meitner, models\nimport os\n\n\nwith Meitner(\n security=models.Security(\n client_credentials=os.getenv(\"MEITNER_CLIENT_CREDENTIALS\", \"\"),\n client_secret=os.getenv(\"MEITNER_CLIENT_SECRET\", \"\"),\n ),\n) as m_client:\n\n res = m_client.schools.list(limit=1, offset=0)\n\n while res is not None:\n # Handle items\n\n res = res.next()\n\n```\n<!-- End Pagination [pagination] -->\n\n<!-- Start Retries [retries] -->\n## Retries\n\nSome of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.\n\nTo change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:\n```python\nfrom meitner import Meitner, models\nfrom meitner.utils import BackoffStrategy, RetryConfig\nimport os\n\n\nwith Meitner(\n security=models.Security(\n client_credentials=os.getenv(\"MEITNER_CLIENT_CREDENTIALS\", \"\"),\n client_secret=os.getenv(\"MEITNER_CLIENT_SECRET\", \"\"),\n ),\n) as m_client:\n\n res = m_client.schools.list(limit=1, offset=0,\n RetryConfig(\"backoff\", BackoffStrategy(1, 50, 1.1, 100), False))\n\n while res is not None:\n # Handle items\n\n res = res.next()\n\n```\n\nIf you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:\n```python\nfrom meitner import Meitner, models\nfrom meitner.utils import BackoffStrategy, RetryConfig\nimport os\n\n\nwith Meitner(\n retry_config=RetryConfig(\"backoff\", BackoffStrategy(1, 50, 1.1, 100), False),\n security=models.Security(\n client_credentials=os.getenv(\"MEITNER_CLIENT_CREDENTIALS\", \"\"),\n client_secret=os.getenv(\"MEITNER_CLIENT_SECRET\", \"\"),\n ),\n) as m_client:\n\n res = m_client.schools.list(limit=1, offset=0)\n\n while res is not None:\n # Handle items\n\n res = res.next()\n\n```\n<!-- End Retries [retries] -->\n\n<!-- Start Error Handling [errors] -->\n## Error Handling\n\n[`MeitnerError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/meitnererror.py) is the base class for all HTTP error responses. It has the following properties:\n\n| Property | Type | Description |\n| ------------------ | ---------------- | --------------------------------------------------------------------------------------- |\n| `err.message` | `str` | Error message |\n| `err.status_code` | `int` | HTTP response status code eg `404` |\n| `err.headers` | `httpx.Headers` | HTTP response headers |\n| `err.body` | `str` | HTTP body. Can be empty string if no body is returned. |\n| `err.raw_response` | `httpx.Response` | Raw HTTP response |\n| `err.data` | | Optional. Some errors may contain structured data. [See Error Classes](https://github.com/meitner-se/api-client-python/blob/master/#error-classes). |\n\n### Example\n```python\nfrom meitner import Meitner, errors, models\nimport os\n\n\nwith Meitner(\n security=models.Security(\n client_credentials=os.getenv(\"MEITNER_CLIENT_CREDENTIALS\", \"\"),\n client_secret=os.getenv(\"MEITNER_CLIENT_SECRET\", \"\"),\n ),\n) as m_client:\n res = None\n try:\n\n res = m_client.schools.list(limit=1, offset=0)\n\n while res is not None:\n # Handle items\n\n res = res.next()\n\n\n except errors.MeitnerError as e:\n # The base class for HTTP error responses\n print(e.message)\n print(e.status_code)\n print(e.body)\n print(e.headers)\n print(e.raw_response)\n\n # Depending on the method different errors may be thrown\n if isinstance(e, errors.Error400ResponseBody):\n print(e.data.error) # models.Error400ResponseBodyError\n```\n\n### Error Classes\n**Primary errors:**\n* [`MeitnerError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/meitnererror.py): The base class for HTTP error responses.\n * [`Error400ResponseBody`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/error400responsebody.py): Bad Request - The request was malformed or contained invalid parameters. Status code `400`.\n * [`Error401ResponseBody`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/error401responsebody.py): Unauthorized - The request is missing valid authentication credentials. Status code `401`.\n * [`Error403ResponseBody`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/error403responsebody.py): Forbidden - Request is authenticated, but the user is not allowed to perform the operation. Status code `403`.\n * [`Error404ResponseBody`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/error404responsebody.py): Not Found - The requested resource does not exist. Status code `404`.\n * [`Error409ResponseBody`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/error409responsebody.py): Conflict - The request could not be completed due to a conflict. Status code `409`.\n * [`Error429ResponseBody`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/error429responsebody.py): Too Many Requests - When the rate limit has been exceeded. Status code `429`.\n * [`Error500ResponseBody`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/error500responsebody.py): Internal Server Error - An unexpected server error occurred. Status code `500`.\n\n<details><summary>Less common errors (27)</summary>\n\n<br />\n\n**Network errors:**\n* [`httpx.RequestError`](https://www.python-httpx.org/exceptions/#httpx.RequestError): Base class for request errors.\n * [`httpx.ConnectError`](https://www.python-httpx.org/exceptions/#httpx.ConnectError): HTTP client was unable to make a request to a server.\n * [`httpx.TimeoutException`](https://www.python-httpx.org/exceptions/#httpx.TimeoutException): HTTP request timed out.\n\n\n**Inherit from [`MeitnerError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/meitnererror.py)**:\n* [`SchoolCreate422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/schoolcreate422responsebodyerror.py): Validation error for School Create operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*\n* [`SchoolSearch422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/schoolsearch422responsebodyerror.py): Validation error for School Search operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*\n* [`SchoolUpdate422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/schoolupdate422responsebodyerror.py): Validation error for School Update operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*\n* [`GroupCreate422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/groupcreate422responsebodyerror.py): Validation error for Group Create operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*\n* [`GroupSearch422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/groupsearch422responsebodyerror.py): Validation error for Group Search operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*\n* [`GroupUpdate422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/groupupdate422responsebodyerror.py): Validation error for Group Update operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*\n* [`EmployeeCreate422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/employeecreate422responsebodyerror.py): Validation error for Employee Create operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*\n* [`EmployeeSearch422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/employeesearch422responsebodyerror.py): Validation error for Employee Search operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*\n* [`EmployeeUpdate422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/employeeupdate422responsebodyerror.py): Validation error for Employee Update operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*\n* [`EmployeePlacementCreate422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/employeeplacementcreate422responsebodyerror.py): Validation error for EmployeePlacement Create operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*\n* [`EmployeePlacementSearch422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/employeeplacementsearch422responsebodyerror.py): Validation error for EmployeePlacement Search operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*\n* [`EmployeePlacementUpdate422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/employeeplacementupdate422responsebodyerror.py): Validation error for EmployeePlacement Update operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*\n* [`GuardianCreate422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/guardiancreate422responsebodyerror.py): Validation error for Guardian Create operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*\n* [`GuardianSearch422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/guardiansearch422responsebodyerror.py): Validation error for Guardian Search operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*\n* [`GuardianUpdate422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/guardianupdate422responsebodyerror.py): Validation error for Guardian Update operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*\n* [`StudentCreate422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/studentcreate422responsebodyerror.py): Validation error for Student Create operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*\n* [`StudentSearch422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/studentsearch422responsebodyerror.py): Validation error for Student Search operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*\n* [`StudentUpdate422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/studentupdate422responsebodyerror.py): Validation error for Student Update operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*\n* [`StudentPlacementCreate422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/studentplacementcreate422responsebodyerror.py): Validation error for StudentPlacement Create operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*\n* [`StudentPlacementSearch422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/studentplacementsearch422responsebodyerror.py): Validation error for StudentPlacement Search operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*\n* [`StudentPlacementUpdate422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/studentplacementupdate422responsebodyerror.py): Validation error for StudentPlacement Update operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*\n* [`AuditEventSearch422ResponseBodyError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/auditeventsearch422responsebodyerror.py): Validation error for AuditEvent Search operation - request data failed validation. Status code `422`. Applicable to 1 of 46 methods.*\n* [`ResponseValidationError`](https://github.com/meitner-se/api-client-python/blob/master/./src/meitner/errors/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute.\n\n</details>\n\n\\* Check [the method documentation](https://github.com/meitner-se/api-client-python/blob/master/#available-resources-and-operations) to see if the error is applicable.\n<!-- End Error Handling [errors] -->\n\n<!-- Start Server Selection [server] -->\n## Server Selection\n\n### Select Server by Name\n\nYou can override the default server globally by passing a server name to the `server: str` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:\n\n| Name | Server | Description |\n| ------------ | --------------------------------------------- | ----------------------------------------------- |\n| `production` | `https://api.meitner.se/directory/v1` | Server to use in production |\n| `staging` | `https://api.staging.meitner.se/directory/v1` | Server to use when building and testing the API |\n\n#### Example\n\n```python\nfrom meitner import Meitner, models\nimport os\n\n\nwith Meitner(\n server=\"staging\",\n security=models.Security(\n client_credentials=os.getenv(\"MEITNER_CLIENT_CREDENTIALS\", \"\"),\n client_secret=os.getenv(\"MEITNER_CLIENT_SECRET\", \"\"),\n ),\n) as m_client:\n\n res = m_client.schools.list(limit=1, offset=0)\n\n while res is not None:\n # Handle items\n\n res = res.next()\n\n```\n\n### Override Server URL Per-Client\n\nThe default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:\n```python\nfrom meitner import Meitner, models\nimport os\n\n\nwith Meitner(\n server_url=\"https://api.meitner.se/directory/v1\",\n security=models.Security(\n client_credentials=os.getenv(\"MEITNER_CLIENT_CREDENTIALS\", \"\"),\n client_secret=os.getenv(\"MEITNER_CLIENT_SECRET\", \"\"),\n ),\n) as m_client:\n\n res = m_client.schools.list(limit=1, offset=0)\n\n while res is not None:\n # Handle items\n\n res = res.next()\n\n```\n<!-- End Server Selection [server] -->\n\n<!-- Start Custom HTTP Client [http-client] -->\n## Custom HTTP Client\n\nThe Python SDK makes API calls using the [httpx](https://www.python-httpx.org/) HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance.\nDepending on whether you are using the sync or async version of the SDK, you can pass an instance of `HttpClient` or `AsyncHttpClient` respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls.\nThis allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of `httpx.Client` or `httpx.AsyncClient` directly.\n\nFor example, you could specify a header for every request that this sdk makes as follows:\n```python\nfrom meitner import Meitner\nimport httpx\n\nhttp_client = httpx.Client(headers={\"x-custom-header\": \"someValue\"})\ns = Meitner(client=http_client)\n```\n\nor you could wrap the client with your own custom logic:\n```python\nfrom meitner import Meitner\nfrom meitner.httpclient import AsyncHttpClient\nimport httpx\n\nclass CustomClient(AsyncHttpClient):\n client: AsyncHttpClient\n\n def __init__(self, client: AsyncHttpClient):\n self.client = client\n\n async def send(\n self,\n request: httpx.Request,\n *,\n stream: bool = False,\n auth: Union[\n httpx._types.AuthTypes, httpx._client.UseClientDefault, None\n ] = httpx.USE_CLIENT_DEFAULT,\n follow_redirects: Union[\n bool, httpx._client.UseClientDefault\n ] = httpx.USE_CLIENT_DEFAULT,\n ) -> httpx.Response:\n request.headers[\"Client-Level-Header\"] = \"added by client\"\n\n return await self.client.send(\n request, stream=stream, auth=auth, follow_redirects=follow_redirects\n )\n\n def build_request(\n self,\n method: str,\n url: httpx._types.URLTypes,\n *,\n content: Optional[httpx._types.RequestContent] = None,\n data: Optional[httpx._types.RequestData] = None,\n files: Optional[httpx._types.RequestFiles] = None,\n json: Optional[Any] = None,\n params: Optional[httpx._types.QueryParamTypes] = None,\n headers: Optional[httpx._types.HeaderTypes] = None,\n cookies: Optional[httpx._types.CookieTypes] = None,\n timeout: Union[\n httpx._types.TimeoutTypes, httpx._client.UseClientDefault\n ] = httpx.USE_CLIENT_DEFAULT,\n extensions: Optional[httpx._types.RequestExtensions] = None,\n ) -> httpx.Request:\n return self.client.build_request(\n method,\n url,\n content=content,\n data=data,\n files=files,\n json=json,\n params=params,\n headers=headers,\n cookies=cookies,\n timeout=timeout,\n extensions=extensions,\n )\n\ns = Meitner(async_client=CustomClient(httpx.AsyncClient()))\n```\n<!-- End Custom HTTP Client [http-client] -->\n\n<!-- Start Resource Management [resource-management] -->\n## Resource Management\n\nThe `Meitner` class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a [context manager][context-manager] and reuse it across the application.\n\n[context-manager]: https://docs.python.org/3/reference/datamodel.html#context-managers\n\n```python\nfrom meitner import Meitner, models\nimport os\ndef main():\n\n with Meitner(\n security=models.Security(\n client_credentials=os.getenv(\"MEITNER_CLIENT_CREDENTIALS\", \"\"),\n client_secret=os.getenv(\"MEITNER_CLIENT_SECRET\", \"\"),\n ),\n ) as m_client:\n # Rest of application here...\n\n\n# Or when using async:\nasync def amain():\n\n async with Meitner(\n security=models.Security(\n client_credentials=os.getenv(\"MEITNER_CLIENT_CREDENTIALS\", \"\"),\n client_secret=os.getenv(\"MEITNER_CLIENT_SECRET\", \"\"),\n ),\n ) as m_client:\n # Rest of application here...\n```\n<!-- End Resource Management [resource-management] -->\n\n<!-- Start Debugging [debug] -->\n## Debugging\n\nYou can setup your SDK to emit debug logs for SDK requests and responses.\n\nYou can pass your own logger class directly into your SDK.\n```python\nfrom meitner import Meitner\nimport logging\n\nlogging.basicConfig(level=logging.DEBUG)\ns = Meitner(debug_logger=logging.getLogger(\"meitner\"))\n```\n\nYou can also enable a default debug logger by setting an environment variable `MEITNER_DEBUG` to true.\n<!-- End Debugging [debug] -->\n\n<!-- Placeholder for Future Speakeasy SDK Sections -->\n\n# Development\n\n## Maturity\n\nThis SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage\nto a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally\nlooking for the latest version.\n\n## Contributions\n\nWhile we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. \nWe look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release. \n\n### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=meitner&utm_campaign=python)\n",
"bugtrack_url": null,
"license": null,
"summary": "Python Client SDK Generated by Speakeasy.",
"version": "0.0.4",
"project_urls": {
"repository": "https://github.com/meitner-se/api-client-python.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "93b382a214fd68c702f2d8cf069d942b209a6a0b7f3b4d4990fb0898312d01ca",
"md5": "a49dd908bfd164cd3d12340076f801a2",
"sha256": "22240e6a88295b05772a18ec499eca942bb33286132815049c20fe802ecf82d3"
},
"downloads": -1,
"filename": "meitner-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a49dd908bfd164cd3d12340076f801a2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9.2",
"size": 277886,
"upload_time": "2025-10-08T07:39:34",
"upload_time_iso_8601": "2025-10-08T07:39:34.887051Z",
"url": "https://files.pythonhosted.org/packages/93/b3/82a214fd68c702f2d8cf069d942b209a6a0b7f3b4d4990fb0898312d01ca/meitner-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "08bc46234c05c18be3200eb3f7418bf94d89358b34aefb7aaef2c6d2e63946be",
"md5": "b94edcc38c2729fb7e51d9291f51e6bc",
"sha256": "06d248a4d294efb78d70a22910db7392053c573d3440def06730a37bf74f3c8f"
},
"downloads": -1,
"filename": "meitner-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "b94edcc38c2729fb7e51d9291f51e6bc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9.2",
"size": 183401,
"upload_time": "2025-10-08T07:39:36",
"upload_time_iso_8601": "2025-10-08T07:39:36.166495Z",
"url": "https://files.pythonhosted.org/packages/08/bc/46234c05c18be3200eb3f7418bf94d89358b34aefb7aaef2c6d2e63946be/meitner-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-08 07:39:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "meitner-se",
"github_project": "api-client-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "meitner"
}
