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.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for bsiepe from gravatar.com bsiepe

Credits

Author: Björn S. Siepe

License

MIT License (MIT)

Requires

Python >=3.9

Provides Extra

dev docs

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openesm-0.2.0.tar.gz (141.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openesm-0.2.0-py3-none-any.whl (18.0 kB view details)

Uploaded Python 3

File details

Details for the file openesm-0.2.0.tar.gz.

File metadata

  • Download URL: openesm-0.2.0.tar.gz
  • Upload date:
  • Size: 141.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for openesm-0.2.0.tar.gz
Algorithm Hash digest
SHA256 50cb3745bfd8fa4b3613b010f4d37688b28a59cf5e9158fce9fb128f1d916521
MD5 81d40478703ffd52240d8cf1fb609ad4
BLAKE2b-256 f250a24f5dd90f98403cc25f20910f8ca9eebcae9af992bd87622e06a5a902e0

See more details on using hashes here.

Provenance

The following attestation bundles were made for openesm-0.2.0.tar.gz:

Publisher: release.yml on openesm-project/openesm-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file openesm-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: openesm-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 18.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for openesm-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 08a5332e6be1cfcc9277c97a2acbc1ceede7a4921066266429d07f199892ff8c
MD5 2a0672d3aa06b446a7e2ef65c8f602ff
BLAKE2b-256 c9de43d7c71668862a1bbb2e81959b589c80f7706f600858be204f34b7d4745b

See more details on using hashes here.

Provenance

The following attestation bundles were made for openesm-0.2.0-py3-none-any.whl:

Publisher: release.yml on openesm-project/openesm-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page