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.1.0.tar.gz (28.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

paperfetcher-1.1.0-py3-none-any.whl (18.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: paperfetcher-1.1.0.tar.gz
  • Upload date:
  • Size: 28.3 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.62.3 CPython/3.7.6

File hashes

Hashes for paperfetcher-1.1.0.tar.gz
Algorithm Hash digest
SHA256 b66f49325701ca833197860544df7b59dd270a3a63382df2a76db9b136b20be0
MD5 a52058b4d61cd08032b20fe16558bb33
BLAKE2b-256 50430aacca39d8381a378bca8031af17c3608602684f5f5ce463a7c6225b1a9f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: paperfetcher-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 18.2 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.62.3 CPython/3.7.6

File hashes

Hashes for paperfetcher-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c59c2a6e5807463bed672d9635db7b8d02d46efe487c09867a78ddf9d8926d77
MD5 be50631cb198c0cc0a973bc059aef50d
BLAKE2b-256 ea3199f1dbd23ea8deaf071d3ffed716922e4c5a10d2b7ed433426ba8c7e9174

See more details on using hashes here.

Supported by

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