deven367 / search-papers

search-papers

This file will become your README and also the index of your documentation.

Install

git clone https://github.com/deven367/search-papers
cd search-papers
pip install -e .

The package will be soon uploaded on PyPi.

How to use

The API has 2 main functions.

1. set_api_key which takes an API key and sets it for the session.
2. search which takes a query and returns a list of papers.

To get an API key, follow the instructions mentioned here → https://dev.elsevier.com/apikey/create

Using the search CLI

(torch) ➜  search_papers git:(main) ✗ search --help
Usage: search [OPTIONS]

Options:
  -q, --query TEXT            Query string
  -p, --publication TEXT      Publication name
  -oa, --open_access BOOLEAN  Open access
  -o, --offset INTEGER        Offset
  -c, --count INTEGER         Number of results
  -sb, --sort_by TEXT         Sort by
  -csv, --save_to_csv TEXT    Save to csv
  --help                      Show this message and exit.