[![Tests](https://github.com/bdfsaraiva/parshift/actions/workflows/tests.yml/badge.svg)](https://github.com/bdfsaraiva/parshift/actions/workflows/tests.yml)
[![Codecov](https://codecov.io/gh/bdfsaraiva/parshift/branch/main/graph/badge.svg?token=O5ZCGFW78U)](https://codecov.io/gh/bdfsaraiva/parshift)
[![Docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://bdfsaraiva.github.io/parshift)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/bdfsaraiva/py-Participation-Shifts/blob/main/LICENSE)
[![PyPI](https://img.shields.io/pypi/v/parshift)](https://pypi.org/project/parshift/)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
# ParShift
ParShift is a python package based on [Gibson's framework] for the analysis of
conversational sequences.
The framework is established on the concept of participation shift, which refers
to the shifting of individuals between the positions of speaker, target
(addressee), and non-addressee (everyone else), in a group conversation.
## Installation
### From PyPI
```bash
pip install parshift
```
### From source
Directly using pip:
```bash
pip install git+https://github.com/bdfsaraiva/parshift.git#egg=parshift
```
Or each step at a time:
```bash
git clone https://github.com/bdfsaraiva/parshift
cd parshift
pip install .
```
## Getting Started
For an in-depth overview of the features of ParShift please check the
[documentation][docs] or follow along the provided example:
| Name | Link |
|---|---|
| Participation Shifts with ParShift | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)][example1] |
## Features/Improvements
We're open to any idea or suggestion to further improve this package.
If you have an idea or a feature request, just open an [issue]. 🤗
## For developers
After you cloned the repo head into the `parshift` base directory, `cd` into it,
create a virtual environment and then install ParShift in development mode:
```bash
pip install -e .[dev]
```
Make sure that all tests pass and that there aren't any issues:
```bash
pytest
```
Now you are ready to start developing the project! Don't forget to add tests for
every new change or feature!
## Reference
If you use this software, please cite the following reference:
* Ferreira-Saraiva, B.D., Matos-Carvalho, J.P., Fachada, N. & Pita, M. (2023).
ParShift: a Python package to study order and differentiation in group
conversations. *SoftwareX*, 24. 101554.
<https://doi.org/10.1016/j.softx.2023.101554>
## License
[MIT License](LICENSE)
[Gibson's framework]:https://doi.org/10.1353/sof.2003.0055
[docs]:https://bdfsaraiva.github.io/parshift/
[example1]:https://colab.research.google.com/drive/1zjstEdkIZrCSgZFkilNf8kvTkRCS-bYG?usp=sharing
[issue]:https://github.com/bdfsaraiva/parshift/issues/new/choose
Raw data
{
"_id": null,
"home_page": "",
"name": "parshift",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "python,conversation-analysis,participation-shifts,turn-taking",
"author": "",
"author_email": "Bruno Saraiva <bruno.saraiva@ulusofona.pt>, Jo\u00e3o Pedro Carvalho <joao.matos.carvalho@ulusofona.pt>, Nuno Fachada <nuno.fachada@ulusofona.pt>, Manuel Pita <manuel.pita@ulusofona.pt>",
"download_url": "https://files.pythonhosted.org/packages/28/38/3330fce72bd07feb67753ff9edc25a319e0911db6a3c036a99d92b44dec6/parshift-1.0.1.tar.gz",
"platform": null,
"description": "[![Tests](https://github.com/bdfsaraiva/parshift/actions/workflows/tests.yml/badge.svg)](https://github.com/bdfsaraiva/parshift/actions/workflows/tests.yml)\n[![Codecov](https://codecov.io/gh/bdfsaraiva/parshift/branch/main/graph/badge.svg?token=O5ZCGFW78U)](https://codecov.io/gh/bdfsaraiva/parshift)\n[![Docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://bdfsaraiva.github.io/parshift)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/bdfsaraiva/py-Participation-Shifts/blob/main/LICENSE)\n[![PyPI](https://img.shields.io/pypi/v/parshift)](https://pypi.org/project/parshift/)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n\n# ParShift\n\nParShift is a python package based on [Gibson's framework] for the analysis of\nconversational sequences.\n\nThe framework is established on the concept of participation shift, which refers\nto the shifting of individuals between the positions of speaker, target\n(addressee), and non-addressee (everyone else), in a group conversation.\n\n## Installation\n\n### From PyPI\n\n```bash\npip install parshift\n```\n\n### From source\n\nDirectly using pip:\n\n```bash\npip install git+https://github.com/bdfsaraiva/parshift.git#egg=parshift\n```\n\nOr each step at a time:\n\n```bash\ngit clone https://github.com/bdfsaraiva/parshift\ncd parshift\npip install .\n```\n\n## Getting Started\n\nFor an in-depth overview of the features of ParShift please check the\n[documentation][docs] or follow along the provided example:\n\n| Name | Link |\n|---|---|\n| Participation Shifts with ParShift | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)][example1] |\n\n## Features/Improvements\n\nWe're open to any idea or suggestion to further improve this package.\nIf you have an idea or a feature request, just open an [issue]. \ud83e\udd17\n\n## For developers\n\nAfter you cloned the repo head into the `parshift` base directory, `cd` into it,\ncreate a virtual environment and then install ParShift in development mode:\n\n```bash\npip install -e .[dev]\n```\n\nMake sure that all tests pass and that there aren't any issues:\n\n```bash\npytest\n```\n\nNow you are ready to start developing the project! Don't forget to add tests for\nevery new change or feature!\n\n## Reference\n\nIf you use this software, please cite the following reference:\n\n* Ferreira-Saraiva, B.D., Matos-Carvalho, J.P., Fachada, N. & Pita, M. (2023).\n ParShift: a Python package to study order and differentiation in group\n conversations. *SoftwareX*, 24. 101554.\n <https://doi.org/10.1016/j.softx.2023.101554>\n\n## License\n\n[MIT License](LICENSE)\n\n[Gibson's framework]:https://doi.org/10.1353/sof.2003.0055\n[docs]:https://bdfsaraiva.github.io/parshift/\n[example1]:https://colab.research.google.com/drive/1zjstEdkIZrCSgZFkilNf8kvTkRCS-bYG?usp=sharing\n[issue]:https://github.com/bdfsaraiva/parshift/issues/new/choose\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python package based on Gibson's framework (2003) for turn-taking in group conversation analysis.",
"version": "1.0.1",
"project_urls": {
"Bug Tracker": "https://github.com/bdfsaraiva/parshift/issues",
"Documentation": "https://bdfsaraiva.github.io/parshift/",
"Homepage": "https://github.com/bdfsaraiva/parshift"
},
"split_keywords": [
"python",
"conversation-analysis",
"participation-shifts",
"turn-taking"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f8320c8b58e234d4af1ac8f2343b0b518795000742967aef87aa3d5a4680cfa7",
"md5": "98b592d7ec88acca9b700caa9ac92d44",
"sha256": "435bf5ef7b871d175b83012c08ccdca436a36506f732d143629f5c13faab1932"
},
"downloads": -1,
"filename": "parshift-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "98b592d7ec88acca9b700caa9ac92d44",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 12966,
"upload_time": "2023-12-02T10:20:49",
"upload_time_iso_8601": "2023-12-02T10:20:49.119270Z",
"url": "https://files.pythonhosted.org/packages/f8/32/0c8b58e234d4af1ac8f2343b0b518795000742967aef87aa3d5a4680cfa7/parshift-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "28383330fce72bd07feb67753ff9edc25a319e0911db6a3c036a99d92b44dec6",
"md5": "11684366cad5ace6f48469ec68a37ca5",
"sha256": "6407253594c1cacf34f10be0783c1e25e55d03fbe50a92adb2e67083245ba7ad"
},
"downloads": -1,
"filename": "parshift-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "11684366cad5ace6f48469ec68a37ca5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 14725,
"upload_time": "2023-12-02T10:20:50",
"upload_time_iso_8601": "2023-12-02T10:20:50.786949Z",
"url": "https://files.pythonhosted.org/packages/28/38/3330fce72bd07feb67753ff9edc25a319e0911db6a3c036a99d92b44dec6/parshift-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-02 10:20:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bdfsaraiva",
"github_project": "parshift",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "parshift"
}