colrev


Namecolrev JSON
Version 0.13.0 PyPI version JSON
download
home_pagehttps://colrev-environment.github.io/colrev/
SummaryCoLRev: An open-source environment for collaborative reviews
upload_time2024-10-04 09:15:09
maintainerNone
docs_urlNone
authorGerit Wagner
requires_python<4,>=3.9
licenseMIT
keywords research reproducible research open science literature literature review systematic review systematic literature review
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # Collaborative Literature Reviews (CoLRev)

<p align="center">
<img src="https://raw.githubusercontent.com/CoLRev-Ecosystem/colrev/main/docs/figures/logo_small.png" width="400">
</p>

<div align="center">

[![DOI](https://zenodo.org/badge/363073613.svg)](https://zenodo.org/badge/latestdoi/363073613)
[![GitHub release](https://img.shields.io/github/v/release/CoLRev-Ecosystem/colrev.svg)](https://github.com/CoLRev-Environment/colrev/releases/)
[![PyPI - Version](https://img.shields.io/pypi/v/colrev?color=blue)](https://pypi.org/project/colrev/)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/colrev)
[![License](https://img.shields.io/github/license/CoLRev-Ecosystem/colrev.svg)](https://github.com/CoLRev-Environment/colrev/releases/)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
![Documentation Status](https://img.shields.io/github/actions/workflow/status/CoLRev-Ecosystem/colrev/docs_deploy.yml?label=documentation)
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/CoLRev-Ecosystem/colrev/tests.yml?label=tests)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/CoLRev-Ecosystem/colrev/main.svg)](https://results.pre-commit.ci/latest/github/CoLRev-Ecosystem/colrev/main)
![Coverage](https://raw.githubusercontent.com/CoLRev-Ecosystem/colrev/main/tests/coverage.svg)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/bd4e44c6cda646e4b9e494c4c4d9487b)](https://app.codacy.com/gh/CoLRev-Environment/colrev/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
![GitHub last commit](https://img.shields.io/github/last-commit/CoLRev-Ecosystem/colrev)
[![Downloads](https://static.pepy.tech/badge/colrev/month)](https://pepy.tech/project/colrev)
[![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/7148/badge)](https://bestpractices.coreinfrastructure.org/projects/7148)
[![SWH](https://archive.softwareheritage.org/badge/origin/https://github.com/CoLRev-Environment/colrev/)](https://archive.softwareheritage.org/browse/origin/?origin_url=https://github.com/CoLRev-Environment/colrev/)<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-32-green.svg?style=flat-square)](#contributors)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
<!-- ![PyPI](https://img.shields.io/pypi/v/colrev) -->

</div>

## Summary

CoLRev is an open-source environment for collaborative literature reviews. It integrates with differerent synthesis tools, takes care of the data, and facilitates Git-based collaboration.

To accomplish these goals, CoLRev advances the design of review technology at the intersection of methods, design, cognition, and community building.
The following features stand out:

- Supports all literature review steps: problem formulation, search, dedupe, (pre)screen, pdf retrieval and preparation, and synthesis
- An open and extensible environment based on shared data and process standards
- Builds on git and its transparent collaboration model for the entire literature review process
- Offers a self-explanatory, fault-tolerant, and configurable user workflow
- Operates a model for data quality, content curation, and reuse
- Enables typological and methodological pluralism throughout the process

![Demo](docs/source/_static/demo.gif)

For details, consult the [documentation](https://colrev-environment.github.io/colrev/).

## Demo

You can try a live demonstration of CoLRev via GitHub codespaces: [start demo](https://github.com//codespaces/new?hide_repo_select=true&ref=main&repo=767717822).

## Contributing, changes, and releases

Contributions, code and features are always welcome

- See [contributing guidelines](CONTRIBUTING.md), [help page](https://colrev-environment.github.io/colrev/manual/help.html), and [github repository](https://github.com/CoLRev-Environment/colrev).
- Bug reports or feedback? Please use the [issue tracker](https://github.com/CoLRev-Environment/colrev/issues) and let us know.
- To get your work included, fork the repository, implement your changes, and create a [pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).

For further information, see [tests](tests/readme.md), [changes](CHANGELOG.md), and [releases](https://github.com/CoLRev-Environment/colrev/releases).

## Contributors

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
  <tbody>
    <tr>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/geritwagner"><img src="https://avatars.githubusercontent.com/u/3872815?v=4?s=100" width="100px;" alt="Gerit Wagner"/><br /><sub><b>Gerit Wagner</b></sub></a><br /><a href="https://github.com/CoLRev-Environment/colrev/commits?author=geritwagner" title="Code">💻</a> <a href="https://github.com/CoLRev-Environment/colrev/commits?author=geritwagner" title="Documentation">📖</a> <a href="#data-geritwagner" title="Data">🔣</a> <a href="#content-geritwagner" title="Content">🖋</a> <a href="#example-geritwagner" title="Examples">💡</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://julianprester.com"><img src="https://avatars.githubusercontent.com/u/4706870?v=4?s=100" width="100px;" alt="Julian Prester"/><br /><sub><b>Julian Prester</b></sub></a><br /><a href="https://github.com/CoLRev-Environment/colrev/commits?author=julianprester" title="Code">💻</a> <a href="https://github.com/CoLRev-Environment/colrev/commits?author=julianprester" title="Documentation">📖</a> <a href="#data-julianprester" title="Data">🔣</a> <a href="#content-julianprester" title="Content">🖋</a> <a href="https://github.com/CoLRev-Environment/colrev/issues?q=author%3Ajulianprester" title="Bug reports">🐛</a> <a href="#ideas-julianprester" title="Ideas, Planning, & Feedback">🤔</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/tmahmood"><img src="https://avatars.githubusercontent.com/u/34904?v=4?s=100" width="100px;" alt="Tarin Mahmood"/><br /><sub><b>Tarin Mahmood</b></sub></a><br /><a href="https://github.com/CoLRev-Environment/colrev/commits?author=tmahmood" title="Code">💻</a> <a href="https://github.com/CoLRev-Environment/colrev/commits?author=tmahmood" title="Tests">⚠️</a> <a href="https://github.com/CoLRev-Environment/colrev/commits?author=tmahmood" title="Documentation">📖</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/dengdenglele"><img src="https://avatars.githubusercontent.com/u/28404427?v=4?s=100" width="100px;" alt="dengdenglele"/><br /><sub><b>dengdenglele</b></sub></a><br /><a href="#data-dengdenglele" title="Data">🔣</a> <a href="https://github.com/CoLRev-Environment/colrev/commits?author=dengdenglele" title="Documentation">📖</a> <a href="https://github.com/CoLRev-Environment/colrev/commits?author=dengdenglele" title="Tests">⚠️</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/mhlbrsimon"><img src="https://avatars.githubusercontent.com/u/83401831?v=4?s=100" width="100px;" alt="mhlbrsimon"/><br /><sub><b>mhlbrsimon</b></sub></a><br /><a href="https://github.com/CoLRev-Environment/colrev/commits?author=mhlbrsimon" title="Code">💻</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/ossendorfluca"><img src="https://avatars.githubusercontent.com/u/112037612?v=4?s=100" width="100px;" alt="ossendorfluca"/><br /><sub><b>ossendorfluca</b></sub></a><br /><a href="https://github.com/CoLRev-Environment/colrev/commits?author=ossendorfluca" title="Code">💻</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/katharinaernst"><img src="https://avatars.githubusercontent.com/u/131549085?v=4?s=100" width="100px;" alt="katharinaernst"/><br /><sub><b>katharinaernst</b></sub></a><br /><a href="https://github.com/CoLRev-Environment/colrev/commits?author=katharinaernst" title="Code">💻</a></td>
    </tr>
    <tr>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/einfachjessi"><img src="https://avatars.githubusercontent.com/u/131001755?v=4?s=100" width="100px;" alt="einfachjessi"/><br /><sub><b>einfachjessi</b></sub></a><br /><a href="https://github.com/CoLRev-Environment/colrev/commits?author=einfachjessi" title="Code">💻</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Janus678"><img src="https://avatars.githubusercontent.com/u/131582517?v=4?s=100" width="100px;" alt="Janus678"/><br /><sub><b>Janus678</b></sub></a><br /><a href="https://github.com/CoLRev-Environment/colrev/commits?author=Janus678" title="Code">💻</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/frxdericz"><img src="https://avatars.githubusercontent.com/u/131789939?v=4?s=100" width="100px;" alt="frxdericz"/><br /><sub><b>frxdericz</b></sub></a><br /><a href="https://github.com/CoLRev-Environment/colrev/commits?author=frxdericz" title="Code">💻</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/MalouSchmidt"><img src="https://avatars.githubusercontent.com/u/131263679?v=4?s=100" width="100px;" alt="MalouSchmidt"/><br /><sub><b>MalouSchmidt</b></sub></a><br /><a href="https://github.com/CoLRev-Environment/colrev/commits?author=MalouSchmidt" title="Code">💻</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/RheaDoesStuff"><img src="https://avatars.githubusercontent.com/u/74066245?v=4?s=100" width="100px;" alt="RheaDoesStuff"/><br /><sub><b>RheaDoesStuff</b></sub></a><br /><a href="https://github.com/CoLRev-Environment/colrev/commits?author=RheaDoesStuff" title="Code">💻</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Cohen2000"><img src="https://avatars.githubusercontent.com/u/113113352?v=4?s=100" width="100px;" alt="Cohen2000"/><br /><sub><b>Cohen2000</b></sub></a><br /><a href="https://github.com/CoLRev-Environment/colrev/commits?author=Cohen2000" title="Code">💻</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/RobertAhr"><img src="https://avatars.githubusercontent.com/u/131687952?v=4?s=100" width="100px;" alt="RobertAhr"/><br /><sub><b>RobertAhr</b></sub></a><br /><a href="https://github.com/CoLRev-Environment/colrev/commits?author=RobertAhr" title="Code">💻</a></td>
    </tr>
    <tr>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/ThomasFleischmann"><img src="https://avatars.githubusercontent.com/u/131684139?v=4?s=100" width="100px;" alt="ThomasFleischmann"/><br /><sub><b>ThomasFleischmann</b></sub></a><br /><a href="https://github.com/CoLRev-Environment/colrev/commits?author=ThomasFleischmann" title="Code">💻</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/AntonFrisch"><img src="https://avatars.githubusercontent.com/u/131719653?v=4?s=100" width="100px;" alt="AntonFrisch"/><br /><sub><b>AntonFrisch</b></sub></a><br /><a href="https://github.com/CoLRev-Environment/colrev/commits?author=AntonFrisch" title="Code">💻</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/LouisLangenhan"><img src="https://avatars.githubusercontent.com/u/148447366?v=4?s=100" width="100px;" alt="LouisLangenhan"/><br /><sub><b>LouisLangenhan</b></sub></a><br /><a href="https://github.com/CoLRev-Environment/colrev/commits?author=LouisLangenhan" title="Code">💻</a> <a href="https://github.com/CoLRev-Environment/colrev/commits?author=LouisLangenhan" title="Documentation">📖</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Peteer98"><img src="https://avatars.githubusercontent.com/u/148191162?v=4?s=100" width="100px;" alt="Peter Eckhardt"/><br /><sub><b>Peter Eckhardt</b></sub></a><br /><a href="https://github.com/CoLRev-Environment/colrev/commits?author=Peteer98" title="Code">💻</a> <a href="https://github.com/CoLRev-Environment/colrev/commits?author=Peteer98" title="Documentation">📖</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/user123projekt"><img src="https://avatars.githubusercontent.com/u/149078858?v=4?s=100" width="100px;" alt="User123projekt"/><br /><sub><b>User123projekt</b></sub></a><br /><a href="https://github.com/CoLRev-Environment/colrev/commits?author=User123projekt" title="Code">💻</a> <a href="https://github.com/CoLRev-Environment/colrev/commits?author=User123projekt" title="Documentation">📖</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/LuminousLynx"><img src="https://avatars.githubusercontent.com/u/148456911?v=4?s=100" width="100px;" alt="LuminousLynx"/><br /><sub><b>LuminousLynx</b></sub></a><br /><a href="https://github.com/CoLRev-Environment/colrev/commits?author=LuminousLynx" title="Code">💻</a> <a href="https://github.com/CoLRev-Environment/colrev/commits?author=LuminousLynx" title="Documentation">📖</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/koljarinne"><img src="https://avatars.githubusercontent.com/u/167416691?v=4?s=100" width="100px;" alt="koljarinne"/><br /><sub><b>koljarinne</b></sub></a><br /><a href="https://github.com/CoLRev-Environment/colrev/commits?author=koljarinne" title="Code">💻</a></td>
    </tr>
    <tr>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/k-schnickmann"><img src="https://avatars.githubusercontent.com/u/168131195?v=4?s=100" width="100px;" alt="Karl Schnickmann"/><br /><sub><b>Karl Schnickmann</b></sub></a><br /><a href="https://github.com/CoLRev-Environment/colrev/commits?author=k-schnickmann" title="Code">💻</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/edensarrival"><img src="https://avatars.githubusercontent.com/u/42614229?v=4?s=100" width="100px;" alt="edensarrival"/><br /><sub><b>edensarrival</b></sub></a><br /><a href="https://github.com/CoLRev-Environment/colrev/commits?author=edensarrival" title="Code">💻</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/U1TIM4T3"><img src="https://avatars.githubusercontent.com/u/167421727?v=4?s=100" width="100px;" alt="U1TIM4T3"/><br /><sub><b>U1TIM4T3</b></sub></a><br /><a href="https://github.com/CoLRev-Environment/colrev/commits?author=U1TIM4T3" title="Code">💻</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/annaglr"><img src="https://avatars.githubusercontent.com/u/76491696?v=4?s=100" width="100px;" alt="Anna Geßler"/><br /><sub><b>annaglr</b></sub></a><br /><a href="https://github.com/CoLRev-Environment/colrev/commits?author=annaglr" title="Code">💻</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/0xmtyset"><img src="https://avatars.githubusercontent.com/u/160525679?v=4?s=100" width="100px;" alt="0xmtyset"/><br /><sub><b>0xmtyset</b></sub></a><br /><a href="https://github.com/CoLRev-Environment/colrev/commits?author=0xmtyset" title="Code">💻</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/tobiaspffl"><img src="https://avatars.githubusercontent.com/u/134608287?v=4?s=100" width="100px;" alt="tobiaspffl"/><br /><sub><b>tobiaspffl</b></sub></a><br /><a href="https://github.com/CoLRev-Environment/colrev/commits?author=tobiaspffl" title="Code">💻</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/CelinaSchwarz"><img src="https://avatars.githubusercontent.com/u/71493743?v=4?s=100" width="100px;" alt="CelinaSchwarz"/><br /><sub><b>CelinaSchwarz</b></sub></a><br /><a href="https://github.com/CoLRev-Environment/colrev/commits?author=CelinaSchwarz" title="Code">💻</a></td>
    </tr>
    <tr>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/QuynhMaiNguyen"><img src="https://avatars.githubusercontent.com/u/167417535?v=4?s=100" width="100px;" alt="QuynhMaiNguyen"/><br /><sub><b>QuynhMaiNguyen</b></sub></a><br /><a href="https://github.com/CoLRev-Environment/colrev/commits?author=QuynhMaiNguyen" title="Code">💻</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/pmao0907"><img src="https://avatars.githubusercontent.com/u/167312265?v=4?s=100" width="100px;" alt="pmao0907"/><br /><sub><b>pmao0907</b></sub></a><br /><a href="https://github.com/CoLRev-Environment/colrev/commits?author=pmao0907" title="Code">💻</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/MingxinJiang"><img src="https://avatars.githubusercontent.com/u/132772605?v=4?s=100" width="100px;" alt="MingxinJiang"/><br /><sub><b>MingxinJiang</b></sub></a><br /><a href="https://github.com/CoLRev-Environment/colrev/commits?author=MingxinJiang" title="Code">💻</a></td>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/JohannesDiel"><img src="https://avatars.githubusercontent.com/u/167763043?v=4?s=100" width="100px;" alt="JohannesDiel"/><br /><sub><b>JohannesDiel</b></sub></a><br /><a href="https://github.com/CoLRev-Environment/colrev/commits?author=JohannesDiel" title="Code">💻</a></td>
    </tr>
  </tbody>
</table>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

## License

This project is distributed under the [MIT License](LICENSE) the documentation is distributed under the [CC-0](https://creativecommons.org/publicdomain/zero/1.0/) license.
If you contribute to the project, you agree to share your contribution following these licenses.

## Citing CoLRev

Please cite the project as follows:

Wagner, G. and Prester, J. (2024) CoLRev - An open-source environment for Collaborative Literature Reviews. Available at https://github.com/CoLRev-Environment/colrev. doi:[10.5281/zenodo.11668338](https://dx.doi.org/10.5281/zenodo.11668338)

Raw data

            {
    "_id": null,
    "home_page": "https://colrev-environment.github.io/colrev/",
    "name": "colrev",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4,>=3.9",
    "maintainer_email": null,
    "keywords": "research, reproducible research, open science, literature, literature review, systematic review, systematic literature review",
    "author": "Gerit Wagner",
    "author_email": "gerit.wagner@uni-bamberg.de",
    "download_url": "https://files.pythonhosted.org/packages/6d/5f/9aa6d83d55fea04afb3940a75360d1377d6bb3c53eab25e541698f551173/colrev-0.13.0.tar.gz",
    "platform": null,
    "description": "# Collaborative Literature Reviews (CoLRev)\n\n<p align=\"center\">\n<img src=\"https://raw.githubusercontent.com/CoLRev-Ecosystem/colrev/main/docs/figures/logo_small.png\" width=\"400\">\n</p>\n\n<div align=\"center\">\n\n[![DOI](https://zenodo.org/badge/363073613.svg)](https://zenodo.org/badge/latestdoi/363073613)\n[![GitHub release](https://img.shields.io/github/v/release/CoLRev-Ecosystem/colrev.svg)](https://github.com/CoLRev-Environment/colrev/releases/)\n[![PyPI - Version](https://img.shields.io/pypi/v/colrev?color=blue)](https://pypi.org/project/colrev/)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/colrev)\n[![License](https://img.shields.io/github/license/CoLRev-Ecosystem/colrev.svg)](https://github.com/CoLRev-Environment/colrev/releases/)\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)\n![Documentation Status](https://img.shields.io/github/actions/workflow/status/CoLRev-Ecosystem/colrev/docs_deploy.yml?label=documentation)\n![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/CoLRev-Ecosystem/colrev/tests.yml?label=tests)\n[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/CoLRev-Ecosystem/colrev/main.svg)](https://results.pre-commit.ci/latest/github/CoLRev-Ecosystem/colrev/main)\n![Coverage](https://raw.githubusercontent.com/CoLRev-Ecosystem/colrev/main/tests/coverage.svg)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/bd4e44c6cda646e4b9e494c4c4d9487b)](https://app.codacy.com/gh/CoLRev-Environment/colrev/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)\n![GitHub last commit](https://img.shields.io/github/last-commit/CoLRev-Ecosystem/colrev)\n[![Downloads](https://static.pepy.tech/badge/colrev/month)](https://pepy.tech/project/colrev)\n[![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/7148/badge)](https://bestpractices.coreinfrastructure.org/projects/7148)\n[![SWH](https://archive.softwareheritage.org/badge/origin/https://github.com/CoLRev-Environment/colrev/)](https://archive.softwareheritage.org/browse/origin/?origin_url=https://github.com/CoLRev-Environment/colrev/)<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->\n[![All Contributors](https://img.shields.io/badge/all_contributors-32-green.svg?style=flat-square)](#contributors)\n<!-- ALL-CONTRIBUTORS-BADGE:END -->\n<!-- ![PyPI](https://img.shields.io/pypi/v/colrev) -->\n\n</div>\n\n## Summary\n\nCoLRev is an open-source environment for collaborative literature reviews. It integrates with differerent synthesis tools, takes care of the data, and facilitates Git-based collaboration.\n\nTo accomplish these goals, CoLRev advances the design of review technology at the intersection of methods, design, cognition, and community building.\nThe following features stand out:\n\n- Supports all literature review steps: problem formulation, search, dedupe, (pre)screen, pdf retrieval and preparation, and synthesis\n- An open and extensible environment based on shared data and process standards\n- Builds on git and its transparent collaboration model for the entire literature review process\n- Offers a self-explanatory, fault-tolerant, and configurable user workflow\n- Operates a model for data quality, content curation, and reuse\n- Enables typological and methodological pluralism throughout the process\n\n![Demo](docs/source/_static/demo.gif)\n\nFor details, consult the [documentation](https://colrev-environment.github.io/colrev/).\n\n## Demo\n\nYou can try a live demonstration of CoLRev via GitHub codespaces: [start demo](https://github.com//codespaces/new?hide_repo_select=true&ref=main&repo=767717822).\n\n## Contributing, changes, and releases\n\nContributions, code and features are always welcome\n\n- See [contributing guidelines](CONTRIBUTING.md), [help page](https://colrev-environment.github.io/colrev/manual/help.html), and [github repository](https://github.com/CoLRev-Environment/colrev).\n- Bug reports or feedback? Please use the [issue tracker](https://github.com/CoLRev-Environment/colrev/issues) and let us know.\n- To get your work included, fork the repository, implement your changes, and create a [pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\n\nFor further information, see [tests](tests/readme.md), [changes](CHANGELOG.md), and [releases](https://github.com/CoLRev-Environment/colrev/releases).\n\n## Contributors\n\n<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->\n<!-- prettier-ignore-start -->\n<!-- markdownlint-disable -->\n<table>\n  <tbody>\n    <tr>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/geritwagner\"><img src=\"https://avatars.githubusercontent.com/u/3872815?v=4?s=100\" width=\"100px;\" alt=\"Gerit Wagner\"/><br /><sub><b>Gerit Wagner</b></sub></a><br /><a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=geritwagner\" title=\"Code\">\ud83d\udcbb</a> <a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=geritwagner\" title=\"Documentation\">\ud83d\udcd6</a> <a href=\"#data-geritwagner\" title=\"Data\">\ud83d\udd23</a> <a href=\"#content-geritwagner\" title=\"Content\">\ud83d\udd8b</a> <a href=\"#example-geritwagner\" title=\"Examples\">\ud83d\udca1</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://julianprester.com\"><img src=\"https://avatars.githubusercontent.com/u/4706870?v=4?s=100\" width=\"100px;\" alt=\"Julian Prester\"/><br /><sub><b>Julian Prester</b></sub></a><br /><a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=julianprester\" title=\"Code\">\ud83d\udcbb</a> <a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=julianprester\" title=\"Documentation\">\ud83d\udcd6</a> <a href=\"#data-julianprester\" title=\"Data\">\ud83d\udd23</a> <a href=\"#content-julianprester\" title=\"Content\">\ud83d\udd8b</a> <a href=\"https://github.com/CoLRev-Environment/colrev/issues?q=author%3Ajulianprester\" title=\"Bug reports\">\ud83d\udc1b</a> <a href=\"#ideas-julianprester\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/tmahmood\"><img src=\"https://avatars.githubusercontent.com/u/34904?v=4?s=100\" width=\"100px;\" alt=\"Tarin Mahmood\"/><br /><sub><b>Tarin Mahmood</b></sub></a><br /><a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=tmahmood\" title=\"Code\">\ud83d\udcbb</a> <a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=tmahmood\" title=\"Tests\">\u26a0\ufe0f</a> <a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=tmahmood\" title=\"Documentation\">\ud83d\udcd6</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/dengdenglele\"><img src=\"https://avatars.githubusercontent.com/u/28404427?v=4?s=100\" width=\"100px;\" alt=\"dengdenglele\"/><br /><sub><b>dengdenglele</b></sub></a><br /><a href=\"#data-dengdenglele\" title=\"Data\">\ud83d\udd23</a> <a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=dengdenglele\" title=\"Documentation\">\ud83d\udcd6</a> <a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=dengdenglele\" title=\"Tests\">\u26a0\ufe0f</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/mhlbrsimon\"><img src=\"https://avatars.githubusercontent.com/u/83401831?v=4?s=100\" width=\"100px;\" alt=\"mhlbrsimon\"/><br /><sub><b>mhlbrsimon</b></sub></a><br /><a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=mhlbrsimon\" title=\"Code\">\ud83d\udcbb</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/ossendorfluca\"><img src=\"https://avatars.githubusercontent.com/u/112037612?v=4?s=100\" width=\"100px;\" alt=\"ossendorfluca\"/><br /><sub><b>ossendorfluca</b></sub></a><br /><a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=ossendorfluca\" title=\"Code\">\ud83d\udcbb</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/katharinaernst\"><img src=\"https://avatars.githubusercontent.com/u/131549085?v=4?s=100\" width=\"100px;\" alt=\"katharinaernst\"/><br /><sub><b>katharinaernst</b></sub></a><br /><a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=katharinaernst\" title=\"Code\">\ud83d\udcbb</a></td>\n    </tr>\n    <tr>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/einfachjessi\"><img src=\"https://avatars.githubusercontent.com/u/131001755?v=4?s=100\" width=\"100px;\" alt=\"einfachjessi\"/><br /><sub><b>einfachjessi</b></sub></a><br /><a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=einfachjessi\" title=\"Code\">\ud83d\udcbb</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/Janus678\"><img src=\"https://avatars.githubusercontent.com/u/131582517?v=4?s=100\" width=\"100px;\" alt=\"Janus678\"/><br /><sub><b>Janus678</b></sub></a><br /><a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=Janus678\" title=\"Code\">\ud83d\udcbb</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/frxdericz\"><img src=\"https://avatars.githubusercontent.com/u/131789939?v=4?s=100\" width=\"100px;\" alt=\"frxdericz\"/><br /><sub><b>frxdericz</b></sub></a><br /><a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=frxdericz\" title=\"Code\">\ud83d\udcbb</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/MalouSchmidt\"><img src=\"https://avatars.githubusercontent.com/u/131263679?v=4?s=100\" width=\"100px;\" alt=\"MalouSchmidt\"/><br /><sub><b>MalouSchmidt</b></sub></a><br /><a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=MalouSchmidt\" title=\"Code\">\ud83d\udcbb</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/RheaDoesStuff\"><img src=\"https://avatars.githubusercontent.com/u/74066245?v=4?s=100\" width=\"100px;\" alt=\"RheaDoesStuff\"/><br /><sub><b>RheaDoesStuff</b></sub></a><br /><a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=RheaDoesStuff\" title=\"Code\">\ud83d\udcbb</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/Cohen2000\"><img src=\"https://avatars.githubusercontent.com/u/113113352?v=4?s=100\" width=\"100px;\" alt=\"Cohen2000\"/><br /><sub><b>Cohen2000</b></sub></a><br /><a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=Cohen2000\" title=\"Code\">\ud83d\udcbb</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/RobertAhr\"><img src=\"https://avatars.githubusercontent.com/u/131687952?v=4?s=100\" width=\"100px;\" alt=\"RobertAhr\"/><br /><sub><b>RobertAhr</b></sub></a><br /><a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=RobertAhr\" title=\"Code\">\ud83d\udcbb</a></td>\n    </tr>\n    <tr>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/ThomasFleischmann\"><img src=\"https://avatars.githubusercontent.com/u/131684139?v=4?s=100\" width=\"100px;\" alt=\"ThomasFleischmann\"/><br /><sub><b>ThomasFleischmann</b></sub></a><br /><a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=ThomasFleischmann\" title=\"Code\">\ud83d\udcbb</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/AntonFrisch\"><img src=\"https://avatars.githubusercontent.com/u/131719653?v=4?s=100\" width=\"100px;\" alt=\"AntonFrisch\"/><br /><sub><b>AntonFrisch</b></sub></a><br /><a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=AntonFrisch\" title=\"Code\">\ud83d\udcbb</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/LouisLangenhan\"><img src=\"https://avatars.githubusercontent.com/u/148447366?v=4?s=100\" width=\"100px;\" alt=\"LouisLangenhan\"/><br /><sub><b>LouisLangenhan</b></sub></a><br /><a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=LouisLangenhan\" title=\"Code\">\ud83d\udcbb</a> <a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=LouisLangenhan\" title=\"Documentation\">\ud83d\udcd6</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/Peteer98\"><img src=\"https://avatars.githubusercontent.com/u/148191162?v=4?s=100\" width=\"100px;\" alt=\"Peter Eckhardt\"/><br /><sub><b>Peter Eckhardt</b></sub></a><br /><a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=Peteer98\" title=\"Code\">\ud83d\udcbb</a> <a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=Peteer98\" title=\"Documentation\">\ud83d\udcd6</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/user123projekt\"><img src=\"https://avatars.githubusercontent.com/u/149078858?v=4?s=100\" width=\"100px;\" alt=\"User123projekt\"/><br /><sub><b>User123projekt</b></sub></a><br /><a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=User123projekt\" title=\"Code\">\ud83d\udcbb</a> <a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=User123projekt\" title=\"Documentation\">\ud83d\udcd6</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/LuminousLynx\"><img src=\"https://avatars.githubusercontent.com/u/148456911?v=4?s=100\" width=\"100px;\" alt=\"LuminousLynx\"/><br /><sub><b>LuminousLynx</b></sub></a><br /><a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=LuminousLynx\" title=\"Code\">\ud83d\udcbb</a> <a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=LuminousLynx\" title=\"Documentation\">\ud83d\udcd6</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/koljarinne\"><img src=\"https://avatars.githubusercontent.com/u/167416691?v=4?s=100\" width=\"100px;\" alt=\"koljarinne\"/><br /><sub><b>koljarinne</b></sub></a><br /><a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=koljarinne\" title=\"Code\">\ud83d\udcbb</a></td>\n    </tr>\n    <tr>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/k-schnickmann\"><img src=\"https://avatars.githubusercontent.com/u/168131195?v=4?s=100\" width=\"100px;\" alt=\"Karl Schnickmann\"/><br /><sub><b>Karl Schnickmann</b></sub></a><br /><a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=k-schnickmann\" title=\"Code\">\ud83d\udcbb</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/edensarrival\"><img src=\"https://avatars.githubusercontent.com/u/42614229?v=4?s=100\" width=\"100px;\" alt=\"edensarrival\"/><br /><sub><b>edensarrival</b></sub></a><br /><a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=edensarrival\" title=\"Code\">\ud83d\udcbb</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/U1TIM4T3\"><img src=\"https://avatars.githubusercontent.com/u/167421727?v=4?s=100\" width=\"100px;\" alt=\"U1TIM4T3\"/><br /><sub><b>U1TIM4T3</b></sub></a><br /><a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=U1TIM4T3\" title=\"Code\">\ud83d\udcbb</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/annaglr\"><img src=\"https://avatars.githubusercontent.com/u/76491696?v=4?s=100\" width=\"100px;\" alt=\"Anna Ge\u00dfler\"/><br /><sub><b>annaglr</b></sub></a><br /><a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=annaglr\" title=\"Code\">\ud83d\udcbb</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/0xmtyset\"><img src=\"https://avatars.githubusercontent.com/u/160525679?v=4?s=100\" width=\"100px;\" alt=\"0xmtyset\"/><br /><sub><b>0xmtyset</b></sub></a><br /><a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=0xmtyset\" title=\"Code\">\ud83d\udcbb</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/tobiaspffl\"><img src=\"https://avatars.githubusercontent.com/u/134608287?v=4?s=100\" width=\"100px;\" alt=\"tobiaspffl\"/><br /><sub><b>tobiaspffl</b></sub></a><br /><a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=tobiaspffl\" title=\"Code\">\ud83d\udcbb</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/CelinaSchwarz\"><img src=\"https://avatars.githubusercontent.com/u/71493743?v=4?s=100\" width=\"100px;\" alt=\"CelinaSchwarz\"/><br /><sub><b>CelinaSchwarz</b></sub></a><br /><a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=CelinaSchwarz\" title=\"Code\">\ud83d\udcbb</a></td>\n    </tr>\n    <tr>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/QuynhMaiNguyen\"><img src=\"https://avatars.githubusercontent.com/u/167417535?v=4?s=100\" width=\"100px;\" alt=\"QuynhMaiNguyen\"/><br /><sub><b>QuynhMaiNguyen</b></sub></a><br /><a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=QuynhMaiNguyen\" title=\"Code\">\ud83d\udcbb</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/pmao0907\"><img src=\"https://avatars.githubusercontent.com/u/167312265?v=4?s=100\" width=\"100px;\" alt=\"pmao0907\"/><br /><sub><b>pmao0907</b></sub></a><br /><a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=pmao0907\" title=\"Code\">\ud83d\udcbb</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/MingxinJiang\"><img src=\"https://avatars.githubusercontent.com/u/132772605?v=4?s=100\" width=\"100px;\" alt=\"MingxinJiang\"/><br /><sub><b>MingxinJiang</b></sub></a><br /><a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=MingxinJiang\" title=\"Code\">\ud83d\udcbb</a></td>\n      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/JohannesDiel\"><img src=\"https://avatars.githubusercontent.com/u/167763043?v=4?s=100\" width=\"100px;\" alt=\"JohannesDiel\"/><br /><sub><b>JohannesDiel</b></sub></a><br /><a href=\"https://github.com/CoLRev-Environment/colrev/commits?author=JohannesDiel\" title=\"Code\">\ud83d\udcbb</a></td>\n    </tr>\n  </tbody>\n</table>\n\n<!-- markdownlint-restore -->\n<!-- prettier-ignore-end -->\n\n<!-- ALL-CONTRIBUTORS-LIST:END -->\n<!-- prettier-ignore-start -->\n<!-- markdownlint-disable -->\n\n<!-- markdownlint-restore -->\n<!-- prettier-ignore-end -->\n\n<!-- ALL-CONTRIBUTORS-LIST:END -->\n\n## License\n\nThis project is distributed under the [MIT License](LICENSE) the documentation is distributed under the [CC-0](https://creativecommons.org/publicdomain/zero/1.0/) license.\nIf you contribute to the project, you agree to share your contribution following these licenses.\n\n## Citing CoLRev\n\nPlease cite the project as follows:\n\nWagner, G. and Prester, J. (2024) CoLRev - An open-source environment for Collaborative Literature Reviews. Available at https://github.com/CoLRev-Environment/colrev. doi:[10.5281/zenodo.11668338](https://dx.doi.org/10.5281/zenodo.11668338)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "CoLRev: An open-source environment for collaborative reviews",
    "version": "0.13.0",
    "project_urls": {
        "Documentation": "https://colrev-environment.github.io/colrev/",
        "Homepage": "https://colrev-environment.github.io/colrev/",
        "Repository": "https://github.com/CoLRev-Environment/colrev"
    },
    "split_keywords": [
        "research",
        " reproducible research",
        " open science",
        " literature",
        " literature review",
        " systematic review",
        " systematic literature review"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bdb68fabf9d3ab1e5a942a469f11b615513a27af74d49f7eac9702b4e06f29ce",
                "md5": "d6393d0d8f7529c0a3143134650ea133",
                "sha256": "d2f279db6830fad4381cca50576fb9979d1bf3533841d4c0e62db30756b513b6"
            },
            "downloads": -1,
            "filename": "colrev-0.13.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d6393d0d8f7529c0a3143134650ea133",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4,>=3.9",
            "size": 924058,
            "upload_time": "2024-10-04T09:15:07",
            "upload_time_iso_8601": "2024-10-04T09:15:07.276406Z",
            "url": "https://files.pythonhosted.org/packages/bd/b6/8fabf9d3ab1e5a942a469f11b615513a27af74d49f7eac9702b4e06f29ce/colrev-0.13.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6d5f9aa6d83d55fea04afb3940a75360d1377d6bb3c53eab25e541698f551173",
                "md5": "2d8cf920b1f92396562a7f9789e86a47",
                "sha256": "f57108e068ee046cbac0c3c372a6384a7ad102eb45e03942cd27be688fcb6096"
            },
            "downloads": -1,
            "filename": "colrev-0.13.0.tar.gz",
            "has_sig": false,
            "md5_digest": "2d8cf920b1f92396562a7f9789e86a47",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4,>=3.9",
            "size": 659010,
            "upload_time": "2024-10-04T09:15:09",
            "upload_time_iso_8601": "2024-10-04T09:15:09.665400Z",
            "url": "https://files.pythonhosted.org/packages/6d/5f/9aa6d83d55fea04afb3940a75360d1377d6bb3c53eab25e541698f551173/colrev-0.13.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-04 09:15:09",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "CoLRev-Environment",
    "github_project": "colrev",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "colrev"
}
Gerit Wagner
Elapsed time: 0.32960s