Altmetric Explorer API Client

A basic API client for extracting data from Altmetric Explorer using the Explorer API (documentation here). This is intended to be a starter for 10 to help you get going with the API and you are encouraged to build out whatever you need from here.

A quick example:

from altmetric.explorer import api

# Get real values at https://www.altmetric.com/explorer/settings
API_KEY = 'abababababababab'
API_SECRET = 'cdcdcdcdcdcdcdcd'

client = api.Client('https://www.altmetric.com/explorer/api', API_KEY, API_SECRET)
response = client.get_mention_sources()

# response.meta returns the meta.response JSON object as a python dict
print(response.meta)

# response.data() returns a python generator that yields one row of data at
# a time.  Paging is handled behind the scenes.
for item in response.data:
  print(item)

Installation

The code can be installed straight from GitHub using pip:

pip install https://github.com/altmetric/altmetric-explorer-api-client/tarball/main

...or by adding the url to your requirements.txt file and running pip install -r requirements.txt.

Getting Started

A docker compose file is included to setup a development environment. Start it by running:

docker compose up # add the -d flag to run in the background

If you have any problems, a good first step is to re-start docker compose with the --build option so that the api container is re-built from scratch.

docker compose down
docker compose up --build

For Developers

The tests are written using pytest.

Run them by starting the docker compose network as described above and then...

docker compose exec app /bin/sh
pytest

or, from the host...

docker compose exec app pytest

The autopep8 linter is installed as well.

You can lint your code by running

docker compose exec app autopep8 --in-place --recursive .