Pybliometrics

---

2025-03-11

* Add new module `pybliometrics.sciencedirect` with new classes: `ScienceDirectSearch()`, `ArticleMetadata()`, `ArticleRetrieval`, `ObjectRetrieval` ,`ArticleEntitlement`, `ObjectMetadata`, `SubjectClassifications()`.
* Deprecate possibility to provide location of configuration file thorugh os.environ.
* Allow for passing of pairs of API key and InstToken.
* Allow for initialization via `pybliometrics.init()`.
* In `ìnit()`, deprecate parameter "config_dir" in favor of "config_path".
* In `AbstractRetrieval().references`, fix bug occurring when article contains just one reference.
* In `AbstractRetrieval().author_group`, use author initials in case the first name is absent.
* In `ScopusSearch().results`, replace "undefined" in field "fund_no" with "None".
* In `ScopusSearch().results`, parse all free-to-read labels, not just the first.
* In `SerialTitle().citescoreyearinfolist`, fix bug due to missing data.
* Raise error when retrieved JSON is malformatted.
* Drop support for python 3.6, 3.7 and 3.8.
* Add support for python 3.12 and 3.13.
* In `AffiliationSearch().affiliations`, always html unescape field "name".
* Fix mistakes and typos in the documentation.

---

2024-07-27

* In `CitationOverview()`, fix bug with implicit parameter `date`, and make this parameter explicit. Include parameter `date` in the cache file name.
* In `AbstractRetrieval().authors`, add new field "collaboration_id" (sort of a hash) and remove field "collaboration", and use field "indexed_name" for the name of the collaboration.
* Unescape all text fields in all classes via `html_unescape()` using optional parameter (default is always True).
* In `ScousSearch()`, enable keyword parameter `count`.
* In `CitationOverview()`, remove deprecated parameter `eid` and deprecate parameters `start` and `end`.
* In `AffiliationSearch()` and `AuthorSearch()`, remove deprecated parameter `count`.
* Fix bug with cache file name generation for `CitationOverview()` when using parameter `citation`.
* Fix bug with creating empty configuration file in default location.
* Fix code examples w.r.t. the `init()` function.

---

2024-05-25

* Introduce mandatory `pybliometrics.scopus.init()` function for start-up.
* Introduce new view ENTITLED for `AbstractRetrieval()`, `AffiliationRetrieval()`, `AuthorRetrieval()` and `ScopusSearch()`.
* In `AffiliationRetrieval.name_variants`, return `None` instead of an empty list.
* In `AffiliationSearch.affiliations`, field `parent` is empty when the returned value is `'0'`.
* In `AuthorRetrieval.name_variants`, field `doc_count` is always integer.
* Fix bug in `AbstractRetrieval().__str__` resulting from missing citations.
* Fix bug in `AbstractRetrieval().references` resulting from malformatted reference information.
* Fix bug in `CitationOverview().cc` resulting from missing citations.

---

2023-12-08

* In `AbstractRetrieval(view="FULL").references`, return all references, not just the first 40.
* In `AbstractRetrieval().issn`, always return a namedtuple indicating the type of the returned ISSN.
* In `AuthorRetrieval(view="LIGHT").affiliation_current`, parse information.
* In `CitationOverview()`, rename property `sourceName` to `sortTitle` in accordance with Scopus' documentation.
* In `SerialTitle().citescoreyearinfolist`, always return a namedtuple.
* In `SerialTitle(view="CITESCORE").citescoreyearinfolist`, provide detailed yearly information.
* In all classes, fix or provide `__str__` where possible.
* Improve all docstrings, add proper format, add code-copy button.
* Update accepted id types of `PlumXMetrics()`.
* In `CitationOverview().cc`, fix bug due to missing citations.
* In `SerialTitle().citescoreyearinfolist`, fix bug with missing current and/or tracker metric.

-----

2023-04-22

* Drop simpleJSON code and dependency.
* Fix bug related to wrong dependency declaration.

-----

2023-04-04

* Fix bug related to installation files.
* Use `importlib` to generate version (except for Sphinx).