Skip to main content

This is a wrapper for the Researchmap API.

Project description

researchmap.py

GitHub license GitHub issues GitHub forks GitHub stars PyPI version Python Versions Downloads

Key Features

  • Modern Pythonic API using async and await.
  • Optimised in both speed and memory.

Installing

Python 3.8 or higher is required

To install the library without full voice support, you can just run the following command:

# Linux/macOS
python3 -m pip install -U researchmap.py

# Windows
py -3 -m pip install -U researchmap.py

To install the development version, do the following:

$ git clone https://github.com/RTa-technology/researchmap.py
$ cd researchmap.py
$ python3 -m pip install -U .

Quick Example

import researchmap

def main():
  with open('env/rmap_jwt_private.key', 'rb') as f_private:
    private_key = f_private.read()
  with open('env/rmap_client_id.key', 'r') as f_id:
    id = f_id.read()
  client_id = id
  client_secret = private_key
  scope = 'read researchers'
  auth = researchmap.Auth(client_id, client_secret, scope)
  access_token = auth.get_access_token()["access_token"]
  req = researchmap.RequestsAdapter(access_token)
  payload = {"format": "json", "limit": 100, "institution_code": "所属機関の機関コード"}
  print(req.get_bulk(payload))

if __name__ == "__main__":
  main()

Contributing

How to localize

$ docs/make.bat gettext
$ sphinx-intl update -p docs/_build/gettext -l ja
$ # Translate the po file.
$ Set-Item env:SPHINXOPTS "-D language=ja"
$ docs/make.bat html

Links

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

researchmap.py-0.0.1.tar.gz (9.9 kB view hashes)

Uploaded Source

Built Distribution

researchmap.py-0.0.1-py3-none-any.whl (10.3 kB view hashes)

Uploaded Python 3

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