Skip to main content

Python package to mine papers for systematic reviews.

Project description

paperfetcher

PyPI version fury.io Build Status Website GitHub license Open Issues

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
  1. 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

paperfetcher-1.0.1.tar.gz (25.7 kB view details)

Uploaded Source

Built Distribution

paperfetcher-1.0.1-py3-none-any.whl (16.0 kB view details)

Uploaded Python 3

File details

Details for the file paperfetcher-1.0.1.tar.gz.

File metadata

  • Download URL: paperfetcher-1.0.1.tar.gz
  • Upload date:
  • Size: 25.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.5.0.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6

File hashes

Hashes for paperfetcher-1.0.1.tar.gz
Algorithm Hash digest
SHA256 f43dd0cc61887ec0dd7e9711554da6726e205033e420335cb877b995da8447dc
MD5 db54f92a1124520215f75ed6c51ce978
BLAKE2b-256 704369a3d3e2d2dbb2ebfa275c600bad61895df797c9ef431612d91fd600098e

See more details on using hashes here.

File details

Details for the file paperfetcher-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: paperfetcher-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 16.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.5.0.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6

File hashes

Hashes for paperfetcher-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0578b898141deee0ab17a479467d09c42bf6c3752ed7ce2f1597720797046486
MD5 b947bb9757840571637512006451efee
BLAKE2b-256 e93c3ed5b8f9e4f1ab812d14142e2de2765c1a3d8cae12eb3a69ed58601f1c73

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page