colrev.github

Version: 0.1.1

Maintainer: Kolja Rinne, Philipp Kasimir, Chris Vierath, Karl Schnickmann, Gerit Wagner

License: MIT

Endpoint	Status	Add
search_source		colrev search --add colrev.github
prep		colrev prep --add colrev.github

Summary

GitHub hosts repositories for code, datasets, and documentation.

search

API search

ℹ️ Restriction: API searches require an GitHub access token to retrieve all the relevant meta data. Store the token in the GITHUB_API_TOKEN environment variable (for example with export GITHUB_API_TOKEN="<your-token>"). If it is not set you will be prompted to enter the token and it will be stored for the current session.

In your GitHub account, a classic personal access tokens can be created. It is not necessary to select any scopes.

Keywords are entered after the search command is executed. The user can chose to search repositories by title, readme files, or both.

colrev search --add colrev.github

Format of the search-history file (API search):

{
    "search_string": "",
    "platform": "colrev.github",
    "search_results_path": "data/search/github_search.bib",
    "search_type": "API",
    "search_parameters": {
        "scope": "url",
        "query": "colrev"
    },
    "version": "0.1.0"
}

prep

GitHub can be used to provide meta data for linking and updating existing records.

colrev prep --add colrev.github