paperfetcher

Release

1.1.0

Paperfetcher is a Python package to automate handsearching and citation searching (snowballing) for systematic reviews. To learn more about Paperfetcher, visit paperfetcher.github.io.

Paperfetcher works with Python 3.7+.

You can either install paperfetcher using pip, or alternatively, clone the source code from Github and install it from source.

Installation with pip

1. Install pip

2. Install paperfetcher using pip

Open a terminal window and run

pip install paperfetcher

OR

Installation from source (requires git)

Source code is available from https://github.com/paperfetcher/paperfetcher

1. Obtain the sources with git

git clone https://github.com/paperfetcher/paperfetcher.git

2. Install package

Open a terminal window in the paperfetcher directory and run

python setup.py install

Running tests (if installed from source)

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

To run unit tests:

cd tests/tests_unit
pytest

To run integration tests:

cd tests/tests_integration
pytest

Usage

To get started, browse the Jupyter notebooks in the examples/ directory in this repository.

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

The Team

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

---

Module documentation:

• paperfetcher package
  • Submodules
  • paperfetcher.apiclients module
  • paperfetcher.datastructures module
  • paperfetcher.exceptions module
  • paperfetcher.handsearch module
  • paperfetcher.parsers module
  • paperfetcher.snowballsearch module
  • Module contents

---

Indices and tables

• Index

• Module Index

• Search Page