psynet-step 0.1.0rc0__tar.gz

psynet_step-0.1.0rc0/.gitignore

@@ -0,0 +1,5 @@
+__pycache__/
+.DS_Store
+build/
+dist/
+*.egg-info/

psynet_step-0.1.0rc0/CHANGELOG.md

@@ -0,0 +1,35 @@
+# Change Log
+
+All important changes to the psynet-step package will be documented here.
+
+The changelog format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and the project uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [v0.1.0]
+
+### Added
+
+- Added a modern PEP 621 `pyproject.toml` (Hatchling backend) so the package can be built and published to PyPI as `psynet-step` (the Python import name remains `step`).
+- Added Python 3.9 / 3.10 / 3.11 / 3.12 / 3.13 classifiers and `requires-python = ">=3.9"`.
+- Added `[project.urls]` for Homepage / Repository / Issues.
+- Added `dev` (pytest), `psynet`, and `publish` optional-dependency extras. The `psynet` extra is only required at runtime when using STEP in a PsyNet experiment; declaring PsyNet as a hard dependency would create a circular dependency if PsyNet ever adds `psynet-step` to its own extras.
+- Added `markupsafe` and `sqlalchemy` as explicit runtime dependencies (previously only available transitively through psynet/dallinger).
+- Added `step/VERSION` as the single source of truth for the package version, read at build time by Hatchling and at import time by `step/__init__.py`.
+- Added `CHANGELOG.md`.
+
+### Changed
+
+- Bumped version from 0.0.1 to 0.1.0 for the first PyPI release.
+- Filled in the LICENSE copyright holder (was a placeholder `[year] [fullname]`).
+- Updated README with PyPI installation instructions and corrected repository URLs.
+- Updated `.gitignore` to exclude `dist/` build artifacts.
+
+### Removed
+
+- Removed `setup.py` (replaced by `pyproject.toml`).
+- Removed `MANIFEST.in` (not used by Hatchling; replaced by explicit wheel/sdist include/exclude rules in `pyproject.toml`).
+- Removed the empty root `__init__.py` (it was not part of the `step` package and served no purpose).
+- Removed `psynet` and `dallinger` from hard runtime dependencies (moved to optional `[psynet]` extra to avoid potential circular dependencies).
+
+## [v0.0.1]
+
+Initial development release (not published to PyPI).

psynet_step-0.1.0rc0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Pol van Rijn, Harin Lee, Peter Harrison, Nori Jacoby
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

psynet_step-0.1.0rc0/PKG-INFO

@@ -0,0 +1,153 @@
+Metadata-Version: 2.4
+Name: psynet-step
+Version: 0.1.0rc0
+Summary: STEP – Sequential Transmission Evaluation Pipeline for PsyNet experiments
+Project-URL: Homepage, https://github.com/pmcharrison/STEP
+Project-URL: Repository, https://github.com/pmcharrison/STEP
+Project-URL: Issues, https://github.com/pmcharrison/STEP/issues
+Author: Harin Lee
+Author-email: Pol van Rijn <pol.van-rijn@ae.mpg.de>, Peter Harrison <pmch2@cam.ac.uk>, Nori Jacoby <nori.jacoby@ae.mpg.de>
+Maintainer-email: Peter Harrison <pmch2@cam.ac.uk>, Frank Höger <fh337@cornell.edu>
+License: MIT License
+        
+        Copyright (c) 2024 Pol van Rijn, Harin Lee, Peter Harrison, Nori Jacoby
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: evaluation,experiments,online,psychology,psynet,tagging
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.9
+Requires-Dist: markupsafe
+Requires-Dist: sqlalchemy
+Provides-Extra: dev
+Requires-Dist: pytest; extra == 'dev'
+Provides-Extra: psynet
+Requires-Dist: psynet; extra == 'psynet'
+Provides-Extra: publish
+Requires-Dist: build; extra == 'publish'
+Requires-Dist: twine; extra == 'publish'
+Description-Content-Type: text/markdown
+
+# STEP — Sequential Transmission Evaluation Pipeline
+
+If you use STEP, please cite:
+> Lee, H., Çelen, E., Harrison, P. M. C., Anglada-Tort, M., Rijn, P. van,
+> Park, M., et al. (2025). *GlobalMood: A cross-cultural benchmark for music
+> emotion recognition*. In *Proceedings of the International Society for Music
+> Information Retrieval Conference (ISMIR)*.
+> https://doi.org/10.48550/arXiv.2505.09539
+
+STEP is a [PsyNet](https://www.psynet.dev/) plugin for running sequential transmission evaluation experiments online. Participants view stimuli (images, audio, video), rate existing tags with stars, flag irrelevant tags, and add new ones. Tags accumulate and converge across participants through an imitation-chain design.
+
+The package ships with:
+
+- **`step`**: the core Python module (trial makers, pages, controls, stimulus classes, i18n support for 36 languages)
+- **`demos/STEP-Tag`**: a working PsyNet demo experiment
+
+## Quick Links
+
+- [Source code](https://github.com/pmcharrison/STEP)
+- [Issues](https://github.com/pmcharrison/STEP/issues)
+- [PsyNet documentation](https://psynetdev.gitlab.io/PsyNet/)
+
+## Installation
+
+### From PyPI
+
+```bash
+pip install psynet-step
+```
+
+The Python import name is `step`:
+
+```python
+from step import StepTag, urls_to_start_nodes
+```
+
+### From source (editable)
+
+```bash
+git clone https://github.com/pmcharrison/STEP.git
+cd STEP
+pip install -e .
+```
+
+### Optional extras
+
+- `psynet` — pulls in PsyNet and Dallinger (required at runtime; already present in any PsyNet experiment environment)
+- `dev` — pytest
+- `publish` — build, twine
+
+Install an extra with, e.g.:
+
+```bash
+pip install -e ".[dev]"
+```
+
+## Usage
+
+```python
+from step import StepTag, urls_to_start_nodes
+import psynet.experiment
+from psynet.timeline import Timeline
+
+class Exp(psynet.experiment.Experiment):
+    timeline = Timeline(
+        StepTag(
+            start_nodes=urls_to_start_nodes(
+                [
+                    "https://mini-kinetics-psy.s3.amazonaws.com/emotional_prosody/03-01-08-02-02-02-24.wav",
+                    "https://s3.amazonaws.com/generalization-datasets/vegetables/images/thaieggplant3.jpg",
+                    "https://mini-kinetics-psy.s3.amazonaws.com/mini-kinetics-validation/cut_videos/[zumba]_dLE5YOEqBGs.mp4",
+                ]
+            ),
+            expected_trials_per_participant=2,
+            max_iterations=5,
+        ),
+    )
+```
+
+In your experiment's `requirements.txt`:
+
+```
+psynet-step==0.1.0
+```
+
+## Running the Demo
+
+```bash
+cd demos/STEP-Tag
+pip install -r constraints.txt
+psynet debug local
+```
+
+## License
+
+MIT License
+

psynet_step-0.1.0rc0/README.md

@@ -0,0 +1,97 @@
+# STEP — Sequential Transmission Evaluation Pipeline
+
+If you use STEP, please cite:
+> Lee, H., Çelen, E., Harrison, P. M. C., Anglada-Tort, M., Rijn, P. van,
+> Park, M., et al. (2025). *GlobalMood: A cross-cultural benchmark for music
+> emotion recognition*. In *Proceedings of the International Society for Music
+> Information Retrieval Conference (ISMIR)*.
+> https://doi.org/10.48550/arXiv.2505.09539
+
+STEP is a [PsyNet](https://www.psynet.dev/) plugin for running sequential transmission evaluation experiments online. Participants view stimuli (images, audio, video), rate existing tags with stars, flag irrelevant tags, and add new ones. Tags accumulate and converge across participants through an imitation-chain design.
+
+The package ships with:
+
+- **`step`**: the core Python module (trial makers, pages, controls, stimulus classes, i18n support for 36 languages)
+- **`demos/STEP-Tag`**: a working PsyNet demo experiment
+
+## Quick Links
+
+- [Source code](https://github.com/pmcharrison/STEP)
+- [Issues](https://github.com/pmcharrison/STEP/issues)
+- [PsyNet documentation](https://psynetdev.gitlab.io/PsyNet/)
+
+## Installation
+
+### From PyPI
+
+```bash
+pip install psynet-step
+```
+
+The Python import name is `step`:
+
+```python
+from step import StepTag, urls_to_start_nodes
+```
+
+### From source (editable)
+
+```bash
+git clone https://github.com/pmcharrison/STEP.git
+cd STEP
+pip install -e .
+```
+
+### Optional extras
+
+- `psynet` — pulls in PsyNet and Dallinger (required at runtime; already present in any PsyNet experiment environment)
+- `dev` — pytest
+- `publish` — build, twine
+
+Install an extra with, e.g.:
+
+```bash
+pip install -e ".[dev]"
+```
+
+## Usage
+
+```python
+from step import StepTag, urls_to_start_nodes
+import psynet.experiment
+from psynet.timeline import Timeline
+
+class Exp(psynet.experiment.Experiment):
+    timeline = Timeline(
+        StepTag(
+            start_nodes=urls_to_start_nodes(
+                [
+                    "https://mini-kinetics-psy.s3.amazonaws.com/emotional_prosody/03-01-08-02-02-02-24.wav",
+                    "https://s3.amazonaws.com/generalization-datasets/vegetables/images/thaieggplant3.jpg",
+                    "https://mini-kinetics-psy.s3.amazonaws.com/mini-kinetics-validation/cut_videos/[zumba]_dLE5YOEqBGs.mp4",
+                ]
+            ),
+            expected_trials_per_participant=2,
+            max_iterations=5,
+        ),
+    )
+```
+
+In your experiment's `requirements.txt`:
+
+```
+psynet-step==0.1.0
+```
+
+## Running the Demo
+
+```bash
+cd demos/STEP-Tag
+pip install -r constraints.txt
+psynet debug local
+```
+
+## License
+
+MIT License
+

psynet_step-0.1.0rc0/pyproject.toml

@@ -0,0 +1,86 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+path = "step/VERSION"
+pattern = "^(?P<version>.+)$"
+
+[project]
+name = "psynet-step"
+dynamic = ["version"]
+authors = [
+    {name = "Pol van Rijn", email = "pol.van-rijn@ae.mpg.de"},
+    {name = "Harin Lee"},
+    {name = "Peter Harrison", email = "pmch2@cam.ac.uk"},
+    {name = "Nori Jacoby", email = "nori.jacoby@ae.mpg.de"},
+]
+maintainers = [
+    {name = "Peter Harrison", email = "pmch2@cam.ac.uk"},
+    {name = "Frank Höger", email = "fh337@cornell.edu"},
+]
+license = {file = "LICENSE"}
+description = "STEP – Sequential Transmission Evaluation Pipeline for PsyNet experiments"
+keywords = ["psychology", "experiments", "online", "evaluation", "tagging", "psynet"]
+readme = "README.md"
+requires-python = ">=3.9"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering",
+]
+
+dependencies = [
+    "markupsafe",
+    "sqlalchemy",
+]
+
+[project.optional-dependencies]
+# `step` is a PsyNet plugin — every class inherits from psynet / dallinger
+# base classes. Declaring psynet as a hard runtime dependency would create a
+# circular install if PsyNet ever adds psynet-step to its own extras. We
+# expose it as an optional extra instead; users running a PsyNet experiment
+# will already have psynet installed.
+psynet = [
+    "psynet",
+]
+dev = [
+    "pytest",
+]
+publish = [
+    "build",
+    "twine",
+]
+
+[project.urls]
+Homepage = "https://github.com/pmcharrison/STEP"
+Repository = "https://github.com/pmcharrison/STEP"
+Issues = "https://github.com/pmcharrison/STEP/issues"
+
+[tool.hatch.build.targets.wheel]
+include = ["/step"]
+
+[tool.hatch.build.targets.wheel.force-include]
+"step/VERSION" = "step/VERSION"
+
+[tool.hatch.build.targets.sdist]
+exclude = [
+    "/.github",
+    "/.flake8",
+    "/.pre-commit-config.yaml",
+    "/.DS_Store",
+    "/.venv*",
+    "/demos",
+    "/__init__.py",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["demos/STEP-Tag"]

psynet_step-0.1.0rc0/step/VERSION

@@ -0,0 +1 @@
+0.1.0rc0