Skip to main content

A Python wrapper around Europeana APIs

Project description

Python interface for Europeana's APIs

This package is a Python wrapper for Europeana's Search and Record APIs.

Installation

As this package is not published on PyPI currently, the only way to install it is through its Git repository host using pip:

pip install https://github.com/europeana/rd-europeana-python-api/archive/stable.zip

From source

git clone https://github.com/europeana/rd-europeana-python-api.git

cd rd-europeana-python-api

pip install -e .

Authentication

Get your API key here

Set EUROPEANA_API_KEY as an environment variable running export EUROPEANA_API_KEY=yourapikey in the terminal.

If running in Google Colab use os.environ['EUROPEANA_API_KEY'] = 'yourapikey'

Usage

from pyeuropeana.apis import SearchWrapper
from pyeuropeana.utils.edm_utils import res2df

result = SearchWrapper(
  query = '*',
  qf = '(skos_concept:"http://data.europeana.eu/concept/base/48" AND TYPE:IMAGE)',
  reusability = 'open AND permission',
  media = True,
  thumbnail = True,
  landingpage = True,
  colourpalette = '#0000FF',
  theme = 'photography',
  sort = 'europeana_id',
  profile = 'rich',
  rows = 1000,
) # this gives you full response metadata along with cultural heritage object metadata

# use this utility function to transform a subset of the cultural heritage object metadata
# into a readable Pandas DataFrame
dataframe = res2df(result, full=False)

Colab tutorial

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

pyeuropeana-0.1.2.tar.gz (13.5 kB view details)

Uploaded Source

Built Distribution

pyeuropeana-0.1.2-py3-none-any.whl (15.3 kB view details)

Uploaded Python 3

File details

Details for the file pyeuropeana-0.1.2.tar.gz.

File metadata

  • Download URL: pyeuropeana-0.1.2.tar.gz
  • Upload date:
  • Size: 13.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.7

File hashes

Hashes for pyeuropeana-0.1.2.tar.gz
Algorithm Hash digest
SHA256 549895ca23b5ec2a077abb4aba1da073f821f24f56a2fd6a6798765db151cf27
MD5 0c33a4c7bd279ba958b5ffe5e8b36da7
BLAKE2b-256 91216ed342a855aad402d5f67e10fade8b9b5f9500c885a01cd6b64669ab011e

See more details on using hashes here.

File details

Details for the file pyeuropeana-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: pyeuropeana-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 15.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.7

File hashes

Hashes for pyeuropeana-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 385b6d4e36363105369ad16ef35e44a3645c184640d89a05805a17fd488f48c1
MD5 ac0d781767b6190d1db57cb7bc21e839
BLAKE2b-256 9c3957c08a59929fb22b8a0d249231f2aaf77184381cd853fb0c87aa8d7ba52f

See more details on using hashes here.

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