Skip to content

Commit

Permalink
Merge pull request #21 from NYU-CI/pypiprep
Browse files Browse the repository at this point in the history
PyPi 1.0.2 release
  • Loading branch information
ceteri authored Dec 15, 2019
2 parents 244e8fe + b9d3721 commit 9b0010e
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 15 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
# richcontext.scholapi

[Rich Context](https://coleridgeinitiative.org/richcontext)
API integrations for federating metadata discovery and exchange across
multiple scholarly infrastructure providers.
API integrations for federating discovery services and metadata
exchange across multiple scholarly infrastructure providers.

Development of the Rich Context knowledge graph uses this library to:

* identify dataset links to research publications
* locate open access publications
* reconcile journal references
* reconcile author profiles
* reconcile keyword mesh

Expand All @@ -22,9 +23,14 @@ Prerequisites:

- [Python 3.x](https://www.python.org/downloads/)
- [Beautiful Soup](https://www.crummy.com/software/BeautifulSoup/bs4/doc/)
- [Biopython.Entrez](https://biopython.org/)
- [Crossref Commons](https://gitlab.com/crossref/crossref_commons_py)
- [Dimensions CLI](https://github.com/digital-science/dimcli)
- [Requests](https://2.python-requests.org/en/master/)
- [Requests-Cache](https://github.com/reclosedev/requests-cache)
- [Selenium](https://github.com/SeleniumHQ/selenium/)
- [xmltodict](https://github.com/martinblech/xmltodict)


To install from [PyPi](https://pypi.python.org/pypi/richcontext.scholapi):

Expand All @@ -45,12 +51,13 @@ and populate it with your credentials.
NB: be careful not to commit the `rc.cfg` file in Git since it
contains sensitive data such as passwords.

Parameters needed in the configuration file include:
Parameters used in the configuration file include:

| parameter | value |
| --- | --- |
| `chrome_exe_path` | path/to/chrome.exe |
| `dimensions_password` | Dimensions API password |
| `elsevier_api_key` | Elsvier API key |
| `email` | personal email address |
| `repec_token` | RePEc API token |

Expand Down Expand Up @@ -117,7 +124,7 @@ installed library.
Then run unit tests for the APIs which do not require credentials:

```
nose2 -v --pretty-assert
python test.py
```


Expand Down
22 changes: 14 additions & 8 deletions changelog.txt
Original file line number Diff line number Diff line change
@@ -1,20 +1,26 @@
# `richcontext.scholapi` changelog

## 1.0.2

2019-12-15

- added publication search and title search for Crossref, PubMed, SSRN
- improved defensive handling for: connection errors, null responses to API calls, returned error messages
- reduced Dimensions API excessive log statements (due to repeated logins)
- resolved errors in handling responses from EuropePMC


## 1.0.1

2019-11-30

### Fixed

* EuropePMC: resolved edge case where returned titles could be null, causing exceptions
- EuropePMC: resolved edge case where returned titles could be null, causing exceptions


## 1.0.0

2019-11-23

### Initial

* first release on PyPi
* supports `title_search()` and `publication_lookup()` using several discovery APIs for Scholarly Infrastructure
* aligned with Community session goals from 2019 Rich Context Workshop (notes by Samuel Klein)
- first release on PyPi
- supports `title_search()` and `publication_lookup()` using several discovery APIs for Scholarly Infrastructure
- aligned with Community session goals from 2019 Rich Context Workshop (notes by Samuel Klein)
9 changes: 6 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,9 @@

setup(
name="richcontext-scholapi",
version="1.0.1",
author="Coleridge Initiative",
author_email="[email protected]",
description="Rich Context API integrations for federating metadata discovery and exchange across multiple scholarly infrastructure providers",
description="Rich Context API integrations for federating discovery services and metadata exchange across multiple scholarly infrastructure providers",
long_description=long_description,
long_description_content_type="text/markdown",
url="https://github.com/NYU-CI/RCApi",
Expand All @@ -29,11 +28,15 @@
python_requires=">=3.5",
install_requires=[
"beautifulsoup4",
"biopython",
"crossref-commons",
"dimcli",
"requests",
"requests-cache",
"selenium",
"xmltodict",
],
keywords="DOI, RePEc, Rich Context, discovery, federated API, federated metadata, knowledge graph, metadata API, metadata exchange, metadata, persistent identifiers, research publication ontology, research publications, scholarly infrastructure, scholarly metadata, scholarly publishing",
keywords="Rich Context, DOI, RePEc, PubMed, Crossref, Dimensions, EuropePMC, OpenAIRE, Unpaywall, dissemin, Semantic Scholar, discovery, discovery service, federated API, federated metadata, knowledge graph, metadata API, metadata exchange, metadata, persistent identifiers, research publication ontology, research publications, scholarly infrastructure, scholarly metadata, scholarly publishing",
license="MIT",
include_package_data=True,
zip_safe=False
Expand Down

0 comments on commit 9b0010e

Please sign in to comment.