Skip to main content

Python package simplifies access to the WoS RESTful API

Project description

restful-wos

A client for Clarivate Analytics' Web of Science RESTful API.

Currently requests and extracts data in RIS format.

Installation

From PyPI via pip

$ pip install restful-wos

Latest development version:

$ git clone git+https://github.com/ConnectedSystems/restful-wos.git
$ cd restful-wos
$ pip install -e .

Usage

Firstly, put your Web of Science access tokens into a yaml file in the following format:

restful_wos:
  wos_lite: YOUR ACCESS TOKEN FOR THE `LITE` API
  wos_expanded: YOUR ACCESS TOKEN FOR THE `EXPANDED` API

Then simply pass in the location of the file to the RESTful client:

import restful_wos

# Create client and send query
client = restful_wos.RESTClient('config.yml')
search_request = 'TS=(uncertain* AND (catchment OR watershed OR water))'
resp = client.query(search_request, time_span=('2018-11-01', '2018-12-31'))

# Convert parsed responses into RIS records
ris_data = restful_wos.to_ris_text(resp)

# Output to a txt file
restful_wos.write_file(ris_data, 'ris_output', overwrite=True)

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

restful-wos-0.1.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

restful_wos-0.1-py3-none-any.whl (7.0 kB view details)

Uploaded Python 3

File details

Details for the file restful-wos-0.1.tar.gz.

File metadata

  • Download URL: restful-wos-0.1.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.4.0.post20200518 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.7

File hashes

Hashes for restful-wos-0.1.tar.gz
Algorithm Hash digest
SHA256 57b26d307a467075ed50972c7a8afd247fdf7bfa7d2b1c3cc10424308c9cea7b
MD5 a9a3036c121ae3cc7ebe8f7c50ebcf0d
BLAKE2b-256 b8a73489a4d7a005fc3bdcb10be025a4808507d427bfc08e87ca5f48f1f6e742

See more details on using hashes here.

File details

Details for the file restful_wos-0.1-py3-none-any.whl.

File metadata

  • Download URL: restful_wos-0.1-py3-none-any.whl
  • Upload date:
  • Size: 7.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.4.0.post20200518 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.7

File hashes

Hashes for restful_wos-0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 27a2e0f4b4cc6a2b9a08bd263511c0e2f6158f7278234f553c4df66caf911a07
MD5 30715c549cfc958f35b447e83760e11a
BLAKE2b-256 b94317e8b99da3727985312be17f50e67a86549696e2a92e0f562a096c1d46d8

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