Changelog#

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased#

0.8.0 - 2024-03-15#

New Features#

  • Added support for returning a list of not found paper IDs in get_papers(). (3eb5516)

  • Added support for bulk retrieval in search_paper(). (0fa8aac)

  • Added support for disabling retrying when getting HTTP status 429 by @qiankunli in #84

Bug Fixes#

  • Fixed #80: get_papers() fails when one of the IDs was not found. (3eb5516)

0.7.0 - 2023-12-29#

New Features#

  • Debug mode (fb249e9)

  • Added new query parameters to search_paper():

  • Added contextsWithIntent property for Citation and Reference (c278e5d)

  • Added citationStyles property to Paper (1e7e6b0)

Enhancements#

  • Increased the default timeout value from 10 to 30 seconds (e5aa367)

  • Reduced the limit parameter (from 1000 to 100) to avoid timeout error and improve performance (846e824)

Breaking Changes#

  • Removed deprecated aliases property from Author (202945c)

0.6.0 - 2023-11-26#

New Features#

  • Added support for asynchronous requests by @gabriel-trigo in #56

  • Added pool_from parameter in get_recommended_papers() (d245515)

Bug Fixes#

  • Fixed the maximum sum of offset and limit from 10,000 to 1,000 (908838a)

Breaking Changes#

  • Removed deprecated URL partner.semanticscholar.org (01c9988)

  • Replaced requests with httpx for asynchronous support

0.5.0 - 2023-08-11#

New Features#

  • Added support for Recommendations API. (ef26088)

Breaking Changes#

  • Spelling fixes object not found exception by @shauryr in #54

  • Removed deprecated parameter graph_api. (4fe2245)

  • Removed deprecated parameter include_unknown_refs. (4f188c8)

0.4.1 - 2023-04-01#

New Features#

  • Added new query parameters to search_paper(): publicationTypes, openAccessPdf, and venue. (79a86ed)

Bug Fixes#

  • Fixed fields of study query parameter name. (2e3b97a)

0.4.0 - 2023-01-23#

New Features#

  • Added support for getting multiple papers or authors at once. (eba2372)

  • Added support for getting details about paper’s author, citation and references. (bd9e19a, 0397761, 6b4f2c7)

  • Added support for getting details about author’s papers. (f186cea)

  • get_author() and get_paper() should now raise an ObjectNotFoundExeception when the Paper or Author ID is not found. (ae50750)

  • New Paper properties: corpusId, openAccessPdf, and publicationVenue. (b2ae2bb)

  • New type: PublicationVenue. (648bd77)

  • Added support for 500 and 504 HTTP errors. (c53c08c, ec23182)

Enhancements#

  • The ValueError exception will be raised when the limit parameter is given a value that is out of bounds.

Breaking Changes#

  • ObjectNotFoundExeception raised instead of returning an empty dict.

  • Removed deprecated methods: author() and paper(). (06a6a53)

Deprecations#

  • Deprecated graph_api parameter. (4acbd11)

  • Deprecated include_unknown_refs parameter in get_paper(). (1d74d22)

0.3.2 - 2022-12-25#

Bug Fixes#

  • Fixed duplicated items issue on traversing results (211bc5d)

0.3.1 - 2022-11-25#

Bug Fixes#

  • Fixed #43: default Partner’s API URL (692d1c7)

0.3.0 - 2022-09-18#

New Features#

  • Added support to the new Academic Graph API and its endpoints, including paper and author search.

  • Library rewrite using the abstraction design instead of a simple API wrapping. Response fields are accessible as properties, but key-based access is still available.

Enhancements#

  • Increased the default timeout of API responses to 10 seconds. (416b271)

Breaking Changes#

  • Removed direct access to deprecated methods paper() and author(). (42d28ca)

Deprecations#

  • Deprecated paper() and author() methods in SemanticScholar class, which are substituted by get_paper() and get_author(). (75d299b)

0.2.1 - 2021-11-02#

Bug Fixes#

  • Fixed API URL definition issue (eee1df9)

0.2.0 - 2021-10-31#

New Features#

  • Added support for S2 Data Partner’s API by @nilsjor in #15

0.1.6 - 2021-09-11#

New Features#

  • Added timeout to semanticscholar requests by @wyh in #7

0.1.5 - 2020-08-18#

Enhancements#

  • Fixed API http type by @wyh in #6

0.1.4 - 2020-03-04#

Dependencies#

0.1.3 - 2019-08-02#