yousleep-common
The youSleep Portal for Python: a typed, asynchronous client for the REST API, the models every request and response is made of, and the tools an analysis container uses to read its manifest and write its result.
pip install yousleep-common
from yousleep_common.client import AsyncClient
from yousleep_common.models import UserAuthentication
client = await AsyncClient.from_credentials(
base_url="https://api.yousleep.ai",
credentials=UserAuthentication(email="you@example.com", password="…"),
)
async with client:
result = await client.workflows.analyze_file(
file="night.edf", analysis_config_id="u-sleep-research-v2"
)
print(result.biomarkers.biomarkers.tst_min, len(result.events))
One call uploads the recording, submits the analysis, waits for it and returns
the events and statistics it produced. analyze_files does the same for a
batch, one outcome per file; the namespaced endpoints (client.projects,
client.analyses, …) are the same operations one level down.
Documentation: docs.yousleep.ai
carries the SDK guides, the generated API reference, and how to package an
analysis to run on the platform. The installed package resolves every
signature offline, so help() and an IDE work without it.
Command line. yousleep-init starts an analysis project that passes the
conformance check as generated, yousleep-verify runs that check on an image,
and yousleep-manifest writes the manifest a container reads for a hand run.
Python 3.11 or later. Every GitHub release also attaches the wheel as an asset, the copy to install from when PyPI's index has not caught up.
Research use. youSleep is for research and other non-commercial use; nothing here is a medical device.
Licensed under Apache-2.0. Contact: contact@yousleep.ai.
1 maintainer
Release files for yousleep-common 31.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| yousleep_common-31.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Release files / yousleep_common-31.0.0-py3-none-any.whl
| Download URL | yousleep_common-31.0.0-py3-none-any.whl |
|---|---|
| Size | 278.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
32e80104ddb6a5b0c82c079c81f3448c9c5e8aa63e94df894c4584422936719a
|
|
BLAKE2b-256 checksum How to use checksums |
4d88e1443d984a164f413343e5234021d925343a60bdc6d08bda8d6d6b6a6da2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 25, 2026.
Transparency log
