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

See the example Jupyter notebooks below to get started:

  1. Crossref hand-search getting started guide
  2. Crossref snowball-search getting started guide (coming soon!)

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 (optional)

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

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-0.2.0.tar.gz (17.6 kB view hashes)

Uploaded Source

Built Distribution

paperfetcher-0.2.0-py3-none-any.whl (13.6 kB view hashes)

Uploaded Python 3

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