paperfetcher

About

Paperfetcher is a Python package to mine papers for systematic reviews. In particular, paperfetcher automates the hand-search and snowball-search portions of the systematic review process.

Paperfetcher works with Python 3.7+.

Usage

You can either use paperfetcher as a Jupyter notebook app (no coding required), or through its easy-to-use Python interface (a little bit of coding required).

View the example Jupyter notebooks below to get started with paperfetcher's Python interface:

1. Crossref hand-search getting started guide
2. Crossref snowball-search getting started guide

Open the example Jupyter notebook apps below on your computer to get started with paperfetcher's cloud interface:

(What is a Jupyter notebook? How do I use it?)

1. Crossref hand-search app
2. Crossref snowball-search app

Once you understand the workflow, read the Module Documentation to learn more about how to use 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 formulated by Qiyang Zhang at the Johns Hopkins University and was developed by Akash Pallath at the University of Pennsylvania.