Skip to main content

openESM Python Package

CI codecov Python versions License: MIT

Python interface for accessing openly available Experience Sampling Method (ESM) datasets

This package provides a Python equivalent to the openESM R package, allowing researchers to programmatically access and download ESM datasets from the openESM repository. All datasets are hosted on Zenodo with proper DOIs for citation.

Features

  • Simple API - Download datasets with a single function call
  • Automatic Caching - Datasets cached locally to avoid re-downloads
  • Citation Helper - Built-in methods for proper dataset citation

Installation

pip install openesm

Quick Start

import openesm

# List available datasets
datasets = openesm.list_datasets()
print(datasets)

# Download a specific dataset
dataset = openesm.get_dataset("0001")
print(dataset.data)  # Access the polars DataFrame
print(dataset.cite())  # Get citation information

# Download multiple datasets
datasets = openesm.get_dataset(["0001", "0002"])

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Metadata

Release files for openesm 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for openesm 0.2.0
File Size Uploaded Provenance
openesm-0.2.0.tar.gz 141.4 kB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for openesm 0.2.0
File Interpreter ABI Platform
openesm-0.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 159.4 kB

Release files / openesm-0.2.0.tar.gz

Download URL openesm-0.2.0.tar.gz
Size 141.4 kB
Tags Source
SHA-256 checksum
How to use checksums
50cb3745bfd8fa4b3613b010f4d37688b28a59cf5e9158fce9fb128f1d916521
BLAKE2b-256 checksum
How to use checksums
f250a24f5dd90f98403cc25f20910f8ca9eebcae9af992bd87622e06a5a902e0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

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 May 8, 2026.

Transparency log

Release files / openesm-0.2.0-py3-none-any.whl

Download URL openesm-0.2.0-py3-none-any.whl
Size 18.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
08a5332e6be1cfcc9277c97a2acbc1ceede7a4921066266429d07f199892ff8c
BLAKE2b-256 checksum
How to use checksums
c9de43d7c71668862a1bbb2e81959b589c80f7706f600858be204f34b7d4745b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

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 May 8, 2026.

Transparency log

Security for openesm 0.2.0

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.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for openesm-0.2.0.tar.gz

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 May 8, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page