-
Notifications
You must be signed in to change notification settings - Fork 10
/
setup.py
50 lines (42 loc) · 16 KB
/
setup.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# coding: utf-8
"""
Web of Science™ Starter API
The Web of Science™ Starter API provides basic metadata and search functionality for Web of Science™ Documents and Journals. Based on your subscription, this API can return times cited of documents. ## Resouces This API follows the REST approach to disclose resources in URL format. Only the GET method is currently available to perform requests over HTTP. The API is available on the [Clarivate Developer Portal](https://developer.clarivate.com/apis/wos-starter). You can find more details about the subscription and the Plans. ## Content You can learn more about content at [Web of Science™ Product Page](https://clarivate.com/webofsciencegroup/solutions/web-of-science/) or in the [Web of Science™ Help](https://webofscience.help.clarivate.com/en-us/Content/home.htm). The following attributes are available from in the API. * UID (Unique Identifier) * Title * Issue * Pages * DOI * Volume * Times Cited * ISSN/eISSN * ISBN * PubMed ID * Source * Web of Science URL * Citing Articles Web of Science URL * Publication Date * Authors * Author Keywords * [Document Type](https://webofscience.help.clarivate.com/en-us/Content/document-types.html) * Cited References Web of Science URL * ResearcherID * Book DOI * Related Records Web of Science URL * Journal Citations Reports URL ## Credentials All requests require authentication with an API Key authentication flow. For more details, check the [Guide][https://developer.clarivate.com/help/api-access#key_access]. ## Search and field tags for Web of Science documents Web of Science™ offers [advanced search query builder](https://webofscience.help.clarivate.com/en-us/Content/advanced-search.html). This API does not support all field tags for documents. [Web of Science API Expanded](https://developer.clarivate.com/apis/wos) offers all available field tags. The following table lists the field tags that are supported by this API. | Field Tag | Description | |-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| | TI | Title of document | | IS | ISSN or ISBN | | SO | Source title - The result contains all source titles within product database (for example, journal titles and/or book titles if the product includes books) | | VL | Volume | | PG | Page | | CS | Issue | | PY | Year Published | | AU | Author | | AI | Author Identifier | | UT | Accession Number | | DO | DOI | | DT | [Document Type](https://webofscience.help.clarivate.com/en-us/Content/document-types.html) | | PMID | PubMed ID | | OG | Search for preferred organization names and/or their name variants from the Preferred Organization Index. <p> A search on a preferred organization name returns all records that contain the preferred name and all records that contain its name variants. A search on a name variant returns all records that contain the variant. For example, Cornell Law Sch returns all records that contain Cornell Law Sch in the Addresses field. <p> When searching for organization names that contain a Boolean (AND, NOT, NEAR, and SAME), always enclose the word in quotation marks ( \" \" ). For example: <p> - OG=(Japan Science \"and\" Technology Agency (JST)) <br> - OG=(\"Near\" East Univ) <br> - OG=(\"OR\" Hlth Sci Univ) | | TS | Searches for topic terms in the following fields within a document: <p> - Title <br> - Abstract <br> - Author keywords <br> - Keywords Plus | SUR | Searches records in DRCI by repository \"SourceURL\". Search values must be inside double quotes ## Pagination To ensure fast response time, each search or multiple entity calls (such as `/documents`) retrieve only a certain number of hits/records. There are two optional request parameters to browse along with the result: _limit_ and _page_. - limit: Number of returned results, ranging from 0 to 50 (default **10**) - page: Specifying a page to retrieve (default **1**) Moreover, this information is shown in the response body, in the tag **metadata**: ```json \"metadata\": { \"total\": 91, \"page\": 1, \"limit\": 10 } ``` ## Errors The WoS Journals API uses conventional HTTP success or failure status codes. For errors, some extra information is included to indicate what went wrong in the JSON response. The list of HTTP codes is listed below. | Code | Title | Description | |---|---|---| | 400 | Bad request | Request syntax error | | 401 | Unauthorized | The API key is invalid or missed | | 404 | Not found | The resource is not found | | 405 | Method not allowed | Method other than GET is not allowed | | 50X | Server errors | Technical error with servers| Each error response (except `401 Unauthorized` error) contains the code of the error, the title of the error and detailed description of the error: a misprint in an endpoint, wrong URL parameter, etc. The example of the error message is shown below: ```json \"error\": { \"status\": 404, \"title\": \"Resource couldn't be found\", \"details\": \"There is no record found in the Web of Science database. Please check your query.\" } ``` For the `401 Unauthorized` error the response body is a little bit different: ```json { \"error_description\": \"The access token is missing\", \"error\": \"invalid_request\" }
The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
from setuptools import setup, find_packages # noqa: H301
# To install the library, run the following
#
# python setup.py install
#
# prerequisite: setuptools
# http://pypi.python.org/pypi/setuptools
NAME = "clarivate-wos-starter-python-client"
VERSION = "1.0.0"
PYTHON_REQUIRES = ">=3.7"
REQUIRES = [
"urllib3 >= 1.25.3, < 2.1.0",
"python-dateutil",
"pydantic >= 2",
"typing-extensions >= 4.7.1",
]
setup(
name=NAME,
version=VERSION,
description="Web of Science™ Starter API",
author="OpenAPI Generator community",
author_email="team@openapitools.org",
url="",
keywords=["OpenAPI", "OpenAPI-Generator", "Web of Science™ Starter API"],
install_requires=REQUIRES,
packages=find_packages(exclude=["test", "tests"]),
include_package_data=True,
license="Clarivate Content as a Service Licence",
long_description_content_type='text/markdown',
long_description="""\
The Web of Science™ Starter API provides basic metadata and search functionality for Web of Science™ Documents and Journals. Based on your subscription, this API can return times cited of documents. ## Resouces This API follows the REST approach to disclose resources in URL format. Only the GET method is currently available to perform requests over HTTP. The API is available on the [Clarivate Developer Portal](https://developer.clarivate.com/apis/wos-starter). You can find more details about the subscription and the Plans. ## Content You can learn more about content at [Web of Science™ Product Page](https://clarivate.com/webofsciencegroup/solutions/web-of-science/) or in the [Web of Science™ Help](https://webofscience.help.clarivate.com/en-us/Content/home.htm). The following attributes are available from in the API. * UID (Unique Identifier) * Title * Issue * Pages * DOI * Volume * Times Cited * ISSN/eISSN * ISBN * PubMed ID * Source * Web of Science URL * Citing Articles Web of Science URL * Publication Date * Authors * Author Keywords * [Document Type](https://webofscience.help.clarivate.com/en-us/Content/document-types.html) * Cited References Web of Science URL * ResearcherID * Book DOI * Related Records Web of Science URL * Journal Citations Reports URL ## Credentials All requests require authentication with an API Key authentication flow. For more details, check the [Guide][https://developer.clarivate.com/help/api-access#key_access]. ## Search and field tags for Web of Science documents Web of Science™ offers [advanced search query builder](https://webofscience.help.clarivate.com/en-us/Content/advanced-search.html). This API does not support all field tags for documents. [Web of Science API Expanded](https://developer.clarivate.com/apis/wos) offers all available field tags. The following table lists the field tags that are supported by this API. | Field Tag | Description | |-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| | TI | Title of document | | IS | ISSN or ISBN | | SO | Source title - The result contains all source titles within product database (for example, journal titles and/or book titles if the product includes books) | | VL | Volume | | PG | Page | | CS | Issue | | PY | Year Published | | AU | Author | | AI | Author Identifier | | UT | Accession Number | | DO | DOI | | DT | [Document Type](https://webofscience.help.clarivate.com/en-us/Content/document-types.html) | | PMID | PubMed ID | | OG | Search for preferred organization names and/or their name variants from the Preferred Organization Index. <p> A search on a preferred organization name returns all records that contain the preferred name and all records that contain its name variants. A search on a name variant returns all records that contain the variant. For example, Cornell Law Sch returns all records that contain Cornell Law Sch in the Addresses field. <p> When searching for organization names that contain a Boolean (AND, NOT, NEAR, and SAME), always enclose the word in quotation marks ( \" \" ). For example: <p> - OG=(Japan Science \"and\" Technology Agency (JST)) <br> - OG=(\"Near\" East Univ) <br> - OG=(\"OR\" Hlth Sci Univ) | | TS | Searches for topic terms in the following fields within a document: <p> - Title <br> - Abstract <br> - Author keywords <br> - Keywords Plus | SUR | Searches records in DRCI by repository \"SourceURL\". Search values must be inside double quotes ## Pagination To ensure fast response time, each search or multiple entity calls (such as `/documents`) retrieve only a certain number of hits/records. There are two optional request parameters to browse along with the result&#58; _limit_ and _page_. - limit&#58; Number of returned results, ranging from 0 to 50 (default **10**) - page&#58; Specifying a page to retrieve (default **1**) Moreover, this information is shown in the response body, in the tag **metadata**&#58; ```json \"metadata\": { \"total\": 91, \"page\": 1, \"limit\": 10 } ``` ## Errors The WoS Journals API uses conventional HTTP success or failure status codes. For errors, some extra information is included to indicate what went wrong in the JSON response. The list of HTTP codes is listed below. | Code | Title | Description | |---|---|---| | 400 | Bad request | Request syntax error | | 401 | Unauthorized | The API key is invalid or missed | | 404 | Not found | The resource is not found | | 405 | Method not allowed | Method other than GET is not allowed | | 50X | Server errors | Technical error with servers| Each error response (except `401 Unauthorized` error) contains the code of the error, the title of the error and detailed description of the error: a misprint in an endpoint, wrong URL parameter, etc. The example of the error message is shown below: ```json \"error\": { \"status\": 404, \"title\": \"Resource couldn't be found\", \"details\": \"There is no record found in the Web of Science database. Please check your query.\" } ``` For the `401 Unauthorized` error the response body is a little bit different: ```json { \"error_description\": \"The access token is missing\", \"error\": \"invalid_request\" }
""", # noqa: E501
package_data={"clarivate.wos_starter.client": ["py.typed"]},
)