psyexp-core

PyPI Python

Task-agnostic harness for PsychoPy experiments, shared across the lab's task repos (heat-task, mid-task, mid-task-deterministic). It owns the plumbing that every task duplicates; each task repo keeps only its own stimuli, trial logic, and record schemas.

What's in here

Module Responsibility
screen setup_screen() — open a fullscreen PsychoPy window, enable VSYNC, run a frame-timing calibration, and return a ScreenDiagnostics.
diagnostics The ScreenDiagnostics dataclass (import-light; no PsychoPy).
rundir make_run_dir(data_dir, label, session_started_at) — timestamped output directory.
manifest write_manifest(...) + system_info() — JSON run manifest with system/display/process diagnostics and the resolved psyexp_core_version. App-specific fields are injected via header / study_params.
recording CsvWriter base class (maps a dataclass record onto a fixed column schema).
wizard questionary / prompt_toolkit setup-wizard primitives: shared styles, ask_text / ask_select / ask_confirm, PosFloatValidator, prompt_unique_name, quit_app.
instructions page_through(...) — a self-paced, keypress-driven instruction pager.
keyboard PTB / PsychoPy-event keyboard abstraction: build_keyboard / get_keys / wait_for_keys / clear_events, plus the timed-press API for response windows — get_presses (name + rt), reset_clock_on_flip / reset_clock / clock_time.

Install

psyexp-core is published on PyPI, so the released harness installs like any other dependency:

uv add psyexp-core          # or: pip install psyexp-core

# your-task/pyproject.toml
dependencies = ["psyexp-core>=0.5"]

Requires Python 3.11+. On macOS the pyobjc-framework-quartz dependency is pulled in automatically for display diagnostics.

Use from a task repo

You can keep the plain PyPI dependency above, or override the source while developing. For day-to-day work, point at a local checkout so edits are live without reinstalling:

# your-task/pyproject.toml
dependencies = ["psyexp-core"]

[tool.uv.sources]
psyexp-core = { path = "../psyexp-core", editable = true }

For a reproducible build pinned ahead of (or instead of) a PyPI release, pin a tagged git ref instead:

[tool.uv.sources]
psyexp-core = { git = "ssh://git@github.com/HAPNlab/psyexp-core.git", tag = "v0.5.1" }

write_manifest records the resolved psyexp_core_version so each run is traceable back to a core version.

Co-developing core while a task repo keeps the git pin

Lab task repos (e.g. heat-task) commit the git-tag source above so clones reproduce exactly, then overlay a local editable install for development:

uv pip install -e ../psyexp-core

Gotcha: uv run re-syncs the task venv from its uv.lock on every launch, which reverts that editable install straight back to the pinned tag (symptoms: your local core edits silently don't take effect). Set UV_NO_SYNC=1 in the task repo (export it in your shell, or use uv run --no-sync) so the editable overlay sticks; run a manual uv sync only when you change other deps, then re-run the editable install. See heat-task's README ("Co-developing psyexp-core locally") for the full workflow.

Releasing

Tagging and the PyPI upload are deliberately separate, so tags stay cheap to iterate on:

  1. Bump + lock + changelog, then tag vX.Y.Z. The tag runs release.yml: the checks, a published GitHub Release, and a built wheel — but it does not upload to PyPI on its own.
  2. The same run pauses on the pypi environment for reviewer approval. Approve it to upload to PyPI via Trusted Publishing (OIDC; no API token stored), or reject to abort.

PyPI versions are immutable, so retagging never republishes; bump the version to ship new code. See docs/releasing.md for the full process, SemVer policy, pre-releases, retag semantics, and the one-time PyPI setup.

Project links

Data verified by PyPI on
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.9.0)

1 maintainer

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

Credits

Author: Eric Wang

GitHub Statistics

Data verified by PyPI on 
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

Requires

Python <3.12, >=3.11

Provides Extra

dev

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

psyexp_core-0.8.0.tar.gz (136.8 kB view details)

Uploaded Source

Built Distribution

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

psyexp_core-0.8.0-py3-none-any.whl (24.5 kB view details)

Uploaded Python 3

File details

Details for the file psyexp_core-0.8.0.tar.gz.

File metadata

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

File hashes

Hashes for psyexp_core-0.8.0.tar.gz
Algorithm Hash digest
SHA256 bf6a27a3d632c2eca564e257435ed0a173bf6c8a5c204225b3d59fd0d030b0eb
MD5 d517372355796bd4999ee419a102fee4
BLAKE2b-256 8b268880f7e0275ad5462c521f30d7d478e32f5d6896133554646014f27b006d

See more details on using hashes here.

Provenance

The following attestation bundles were made for psyexp_core-0.8.0.tar.gz:

Publisher: release.yml on HAPNlab/psyexp-core

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

File details

Details for the file psyexp_core-0.8.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for psyexp_core-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 335fb6094486433dd399ec854e7e81ec93b2436498bfe58a0a3f5a539b0376b5
MD5 ef83f2d191d997297ec8ac1ab9e1ca71
BLAKE2b-256 57326d68358389da5985aaaea2a59b37ca8ed4440a7faf1de7819f3c1888b3a1

See more details on using hashes here.

Provenance

The following attestation bundles were made for psyexp_core-0.8.0-py3-none-any.whl:

Publisher: release.yml on HAPNlab/psyexp-core

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

Supported by

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