# psychopy_bids
A [PsychoPy](https://www.psychopy.org/) plugin to work with the [Brain Imaging Data Structure (BIDS)](https://bids-specification.readthedocs.io/)
* **Website:** https://psygraz.gitlab.io/psychopy-bids
* **Documentation:** https://psychopy-bids.readthedocs.io
* **Source code:** https://gitlab.com/psygraz/psychopy-bids/
* **Contributing:** https://psychopy-bids.readthedocs.io/en/doc/contributing/
* **Bug reports:** https://gitlab.com/psygraz/psychopy-bids/issues
* **Code of Conduct:** https://psychopy-bids.readthedocs.io/en/doc/conduct/
## Installation
```bash
$ pip install psychopy_bids
```
## Usage
`psychopy_bids` can be used to create valid BIDS datasets by adding the possibility of using [task events](https://bids-specification.readthedocs.io/en/stable/04-modality-specific-files/05-task-events.html) in PsychoPy.
```python
from psychopy_bids import bids
handler = bids.BIDSHandler(dataset="example", subject="01", task="A")
handler.createDataset()
event_list = [bids.BIDSTaskEvent(onset=1.0, duration=0, trial_type="trigger")]
participant_info = {"participant_id": handler.subject, "age": 18}
handler.addTaskEvents(event_list, participant_info)
```
## Contributing
Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.
## License
`psychopy_bids` was created by Christoph Anzengruber & Florian Schöngaßner. It is licensed under the terms of the GNU General Public License v3.0 license.
## Credits
`psychopy_bids` was created with [`cookiecutter`](https://cookiecutter.readthedocs.io/en/latest/) and the `py-pkgs-cookiecutter` [template](https://github.com/py-pkgs/py-pkgs-cookiecutter).
Raw data
{
"_id": null,
"home_page": "https://pypi.org/project/psychopy-bids/",
"name": "psychopy_bids",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<3.11",
"maintainer_email": "",
"keywords": "data,dataset,bids",
"author": "Christoph Anzengruber",
"author_email": "christoph.anzengruber@uni-graz.at",
"download_url": "https://files.pythonhosted.org/packages/0e/00/1135f43dfe7d8c3feeed2b7ae8fce1585ba2838432a870f19371994c59cf/psychopy_bids-2023.2.0.tar.gz",
"platform": null,
"description": "# psychopy_bids\n\nA [PsychoPy](https://www.psychopy.org/) plugin to work with the [Brain Imaging Data Structure (BIDS)](https://bids-specification.readthedocs.io/)\n\n* **Website:** https://psygraz.gitlab.io/psychopy-bids\n* **Documentation:** https://psychopy-bids.readthedocs.io\n* **Source code:** https://gitlab.com/psygraz/psychopy-bids/\n* **Contributing:** https://psychopy-bids.readthedocs.io/en/doc/contributing/\n* **Bug reports:** https://gitlab.com/psygraz/psychopy-bids/issues\n* **Code of Conduct:** https://psychopy-bids.readthedocs.io/en/doc/conduct/\n\n## Installation\n\n```bash\n$ pip install psychopy_bids\n```\n\n## Usage\n\n`psychopy_bids` can be used to create valid BIDS datasets by adding the possibility of using [task events](https://bids-specification.readthedocs.io/en/stable/04-modality-specific-files/05-task-events.html) in PsychoPy.\n\n```python\nfrom psychopy_bids import bids\n\nhandler = bids.BIDSHandler(dataset=\"example\", subject=\"01\", task=\"A\")\nhandler.createDataset()\n\nevent_list = [bids.BIDSTaskEvent(onset=1.0, duration=0, trial_type=\"trigger\")]\nparticipant_info = {\"participant_id\": handler.subject, \"age\": 18}\n\nhandler.addTaskEvents(event_list, participant_info)\n```\n\n## Contributing\n\nInterested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.\n\n## License\n\n`psychopy_bids` was created by Christoph Anzengruber & Florian Sch\u00f6nga\u00dfner. It is licensed under the terms of the GNU General Public License v3.0 license.\n\n## Credits\n\n`psychopy_bids` was created with [`cookiecutter`](https://cookiecutter.readthedocs.io/en/latest/) and the `py-pkgs-cookiecutter` [template](https://github.com/py-pkgs/py-pkgs-cookiecutter).\n",
"bugtrack_url": null,
"license": "GNU General Public License v3.0",
"summary": "A PsychoPy plugin for using the Brain Imaging Data Structure (BIDS) to organize and describe data.",
"version": "2023.2.0",
"project_urls": {
"Documentation": "https://psychopy-bids.readthedocs.io/en/latest/",
"Homepage": "https://pypi.org/project/psychopy-bids/",
"Repository": "https://gitlab.com/psygraz/psychopy-bids/"
},
"split_keywords": [
"data",
"dataset",
"bids"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6b9fadbde3b71a0d8ccbc594111d939bc2971a61f3c45a1ea15e2ee2ff731726",
"md5": "b9229815f7b0163340869334fc877271",
"sha256": "6415dcef7a2b989c6d8720381d76403ae631bc51f86b0b944d3e6605c6d01940"
},
"downloads": -1,
"filename": "psychopy_bids-2023.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b9229815f7b0163340869334fc877271",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<3.11",
"size": 181951,
"upload_time": "2023-12-05T18:30:50",
"upload_time_iso_8601": "2023-12-05T18:30:50.857104Z",
"url": "https://files.pythonhosted.org/packages/6b/9f/adbde3b71a0d8ccbc594111d939bc2971a61f3c45a1ea15e2ee2ff731726/psychopy_bids-2023.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0e001135f43dfe7d8c3feeed2b7ae8fce1585ba2838432a870f19371994c59cf",
"md5": "ba18b837ba2eade275e3425fe87de6dd",
"sha256": "4a9d0058debd7cd480a6e7b9441e7bdc599218e5f0c72b5ddfabb9ad3d8b1502"
},
"downloads": -1,
"filename": "psychopy_bids-2023.2.0.tar.gz",
"has_sig": false,
"md5_digest": "ba18b837ba2eade275e3425fe87de6dd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<3.11",
"size": 132274,
"upload_time": "2023-12-05T18:30:54",
"upload_time_iso_8601": "2023-12-05T18:30:54.946407Z",
"url": "https://files.pythonhosted.org/packages/0e/00/1135f43dfe7d8c3feeed2b7ae8fce1585ba2838432a870f19371994c59cf/psychopy_bids-2023.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-05 18:30:54",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "psygraz",
"gitlab_project": "psychopy-bids",
"lcname": "psychopy_bids"
}
JSON