Version 0.10.0

Added

• SearchSources: SYNERGY datasets, OpenAlex, ERIC, IEEEXplore, ArXiv
• JournalRankings: index, prep, and prescreen
• CoLRev shell via cli-repl (colrev shell)
• prep operation: pause and resume
• Dashboard overview of the sample and project status
• Extended tests, updated documentation (especially for extension development)
• GitHub workflows to update dependencies (poetry update)
• Ruff linter

Changed

• Load: ris/csv/... files are loaded directly (without creating intermediate BibTeX file)
• Introduced namespaced fields (e.g., colrev.pubmed.pubmedid instead of pubmedid)
• Extracted quality checks to separate Quality Model
• Docs: instructions for development setup
• Code quality improvements (codacy)

Removed

• colrev-asreview: extracted to separate package
• watchdog-based service

Version 0.9.3

Changed

• Introduced namespaced fields (e.g., colrev.pubmed.pubmedid instead of pubmedid).

Version 0.9.2

Changed

• Updated colrev-asreview dependency (PyPI instead of GitHub)

Version 0.9.1

Changed

• Integrated load into SearchSource. Removed load_conversion endpoint: settings.json, packages, interface etc.

Version 0.9.0

Added

• The quality_model was created to check for quality defects
• The auto_upgrade flag allows users to enable/disable automated upgrades
• All-contributors bot to acknowledge contributions to CoLRev
• Implemented OpenLibrary as a SearchSource
• Pylint check for direct assignment of colrev_status
• Test battery for built-in SearchSources (heuristics, load, prep)
• Backward-search comparison with OpenCitations data

Changed

• Refactored language_service
• Refactored the tests (conftest.py now provides the base_repo_review_manager fixture)
• Changed pdf-hash (pdf to image) from poppler to mupdf for cross-platform compatibility (cpid1 -> cpid2)
• Local settings changed from yaml to json
• Quality defects (colrev_masterdata_provenance notes) change
• The colrev.global_ids_consistency_check prep-endpoint is removed (integrated into the quality model)
• Individual quality checks can be disabled through the prep/defects_to_ignore settings
• Update the Github action workflows in CoLRev repositories

Removed

• timeout-decorator dependency (for better compatibility with MacOS)
• Docker image pdf-hash-service (replaced by mupdf)
• Redundant fields for the backward search are removed (cited_by_file and cited_by_id)

Fixed

• Documentation: typos and inconsistencies
• Codacy issues and refactored complex files 1
• Windows paths in iter_commit (git history)

Version 0.8.4

Changed

• Implemented new quality model
• Quality defects (colrev_masterdata_provenance notes) change
• The colrev.global_ids_consistency_check prep-endpoint is removed (integrated into the quality model)
• Individual quality checks can be disabled through the prep/defects_to_ignore settings
• Redundant fields for the backward search are removed (cited_by_file and cited_by_id)

Version 0.8.3

Changed

• CoLRev pdf IDs are now based on the mupdf library

Version 0.8.2

Fixed

• Fix InvalidGitRepositoryError (raised upon status in empty directories)

Version 0.8.1

Changed

• Update the GitHub action workflows in CoLRev repositories
• Add auto-upgrade flag to settings

Version 0.8.0

Added

• Unit tests: increased test coverage to 70%, added Github actions matrix tests across OS and Python versions
• Completed OpenSSF Best Practices checks (1)
• Added forward and backward searches based on OpenCitations
• Moved documentation to readthedocs and revised documentation
• Added dependabot and pre-commit.ci: automated code and secrity checks
• Added support for Github actions, distinguishing packages that are supported in ci-environments (ci_supported flag)
• Added Pubmed API searches and metadata preparation support
• Option to initialize and run CoLRev repositories without requiring Docker
• Overview video presented at ESMARConf2023 1
• CITATION.cff and Zenodo
• API-searches for the AIS eLibrary

Changed

• Numerous modifications based on the user tests
• Replaced OpenSearch with sqlite
• SearchSource interface: run_search and add_package are now mandatory
• Documentation review, including detailed information on development status
• Consistent setup of Github actions (test, publish to PyPI)
• Built-in packages renamed from colrev_built_in to colrev
• Data package manuscriptrenamed to paper_md
• Simplified upgrade operation and activated upgrades per default
• Extracted and refactored language-service

Fixed

• Several bugfixes