Skip to main content

CoLRev: An open-source environment for collaborative reviews

Project description

DOI PyPI - Version PyPI - Python Version License Documentation Status GitHub Workflow Status pre-commit.ci status Coverage Codacy Badge GitHub last commit Downloads OpenSSF Best Practices SWH GitHub contributors

Collaborative Literature Reviews (CoLRev)

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

For details, consult the documentation.

Demo

You can try a live demonstration of CoLRev via GitHub codespaces: start demo.

Related work (preview)

The following shows a comparison of CoLRev with related tools.

[!Note] This is a preview. We plan to document and link the criteria, verify each cell, and invite the developers of the other tools to comment on the overview (documenting responses if the developers agree).

Criteria CoLRev LitStudy BUHOS Covidence
Review types
Supports different genres of review methods
Extensibility ⚠️ ⚠️
Process steps
Review objectives and protocol
Search
Duplicate handling ⚠️ ⚠️ ⚠️
(Pre)Screen ⚠️
Data extraction ⚠️
Data analysis and quality appraisal ⚠️
Synthesis and reporting
Process qualities
Extensibility
Extensions 111 0 0 0
Search updates ⚠️ ⚠️
Search: APIs ✅ (19) ✅ (7)
Metadata preparation ⚠️
Retract checks
PDF retrieval
PDF preparation ⚠️ ⚠️
Status tracking
Collaboration
Large teams ⚠️ ⚠️ ⚠️
Algorithms ⚠️ ⚠️
Data management
Transparency
Validation
Reporting (e.g., PRISMA)
Publication of review
Platform
OSI-approved license
Peer-reviewed
Technology Python Python Ruby Proprietary
Setup Local or cloud Local or cloud Server Server
Interface CLI, Programmatic (GUI planned) Jupyter Notebook Web-UI Web-UI
Contributors GitHub contributors GitHub contributors GitHub contributors NA
Commits GitHub total commits GitHub total commits GitHub total commits NA
Last commit GitHub last commit GitHub last commit GitHub last commit NA
Pull requests GitHub Issues or Pull Requests GitHub Issues or Pull Requests GitHub Issues or Pull Requests NA
Forks GitHub forks GitHub forks GitHub forks NA
Last release GitHub last release GitHub last release GitHub last release NA
Current release Releases Releases GitHub Release NA

Contributing, changes, and releases

Contributions, code and features are always welcome

For further information, see tests, changes, and releases.

Contributors

Gerit Wagner
Gerit Wagner

💻 📖 🔣 🖋 💡
Julian Prester
Julian Prester

💻 📖 🔣 🖋 🐛 🤔
Tarin Mahmood
Tarin Mahmood

💻 ⚠️ 📖
dengdenglele
dengdenglele

🔣 📖 ⚠️
mhlbrsimon
mhlbrsimon

💻
ossendorfluca
ossendorfluca

💻
katharinaernst
katharinaernst

💻
einfachjessi
einfachjessi

💻
Janus678
Janus678

💻
frxdericz
frxdericz

💻
MalouSchmidt
MalouSchmidt

💻
RheaDoesStuff
RheaDoesStuff

💻
Cohen2000
Cohen2000

💻
RobertAhr
RobertAhr

💻
ThomasFleischmann
ThomasFleischmann

💻
AntonFrisch
AntonFrisch

💻
LouisLangenhan
LouisLangenhan

💻 📖
Peter Eckhardt
Peter Eckhardt

💻 📖
User123projekt
User123projekt

💻 📖
LuminousLynx
LuminousLynx

💻 📖
koljarinne
koljarinne

💻
Karl Schnickmann
Karl Schnickmann

💻
edensarrival
edensarrival

💻
U1TIM4T3
U1TIM4T3

💻
Anna Geßler
annaglr

💻
0xmtyset
0xmtyset

💻
tobiaspffl
tobiaspffl

💻
CelinaSchwarz
CelinaSchwarz

💻
QuynhMaiNguyen
QuynhMaiNguyen

💻
pmao0907
pmao0907

💻
MingxinJiang
MingxinJiang

💻
JohannesDiel
JohannesDiel

💻
julialopezmarti
julialopezmarti

💻
olgagirona
olgagirona

💻
komashevska
komashevska

💻
trathienphuc-tran
trathienphuc-tran

💻
ammar-uni
ammar-uni

💻
Lea-Chaoui
Lea-Chaoui

💻
ChloeT17
ChloeT17

💻

License

This project is distributed under the MIT License the documentation is distributed under the CC-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. (2026) CoLRev - An open-source environment for Collaborative Literature Reviews. Available at https://github.com/CoLRev-Environment/colrev. doi:10.5281/zenodo.11668338

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

colrev-0.16.1.tar.gz (16.2 MB view details)

Uploaded Source

Built Distribution

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

colrev-0.16.1-py3-none-any.whl (1.0 MB view details)

Uploaded Python 3

File details

Details for the file colrev-0.16.1.tar.gz.

File metadata

  • Download URL: colrev-0.16.1.tar.gz
  • Upload date:
  • Size: 16.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.27 {"installer":{"name":"uv","version":"0.9.27","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for colrev-0.16.1.tar.gz
Algorithm Hash digest
SHA256 19741717471a1a0bf654fb5f04a0d5dcb561bea8e4c4308c0ee283258d675913
MD5 5399ae4c3b0a0b4571a24b2d3b3461fb
BLAKE2b-256 9a730b40a8c9cf2f647b3de392ecd06d08c65896a713cbced68c9bcba18a7afc

See more details on using hashes here.

File details

Details for the file colrev-0.16.1-py3-none-any.whl.

File metadata

  • Download URL: colrev-0.16.1-py3-none-any.whl
  • Upload date:
  • Size: 1.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.27 {"installer":{"name":"uv","version":"0.9.27","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for colrev-0.16.1-py3-none-any.whl
Algorithm Hash digest
SHA256 08d50b70d29caf0081c656e32eeb51e2a409fc4b202954138038463228cc822a
MD5 9a34744e18f6bc5b38f2a6b7c4e6a5fd
BLAKE2b-256 b96befd51b551c3177f1cdbb9520a1b7af6bb52195ed2a421efb38a1dde44948

See more details on using hashes here.

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