paperfetcher

About

Paperfetcher is a Python package to automate handsearching and citation searching (snowballing) for systematic reviews. Paperfetcher works with Python 3.7+.

To learn more about Paperfetcher, visit paperfetcher.github.io.

Usage

To get started, browse the following Getting Started Jupyter notebooks (also in the examples/ directory in this repository):

1. Getting started with handsearching
2. Getting started with citation searching

Once you understand the workflow, read the Module Documentation to learn more about paperfetcher's various modules, classes and functions.

Installation

Installation with pip

1. Install pip
2. Install paperfetcher using pip:

pip install paperfetcher

Installation from source

1. Clone this repository
2. In the repository directory, run

python setup.py install

or, if you have pip installed

pip install .

Running tests (if installed from source)

You can run tests to make sure that paperfetcher is working correctly on your system.

1. To run integration tests, in the repository directory, run

cd tests/tests_integration
pytest

2. To run unit tests, in the repository directory, run

cd tests/tests_unit
pytest

The Team

Paperfetcher was developed by Akash Pallath at the University of Pennsylvania and Qiyang Zhang at the Johns Hopkins University.