Skip to main content

Convert search parameters from the Trove web interface into a form the API understands.

Project description

Trove query parser

Convert a query from the Trove web interface into a set of parameters that can be used with the Trove API.


pip install trove-query-parser

How to use

  • Construct a search in the Trove 'Newspapers and Gazettes' category.
  • Copy the search url.
  • Feed the url to the parse_query function

The second parameter to parse_query is the Trove API version number. The default is 2 for backwards compatibility.

from trove_query_parser.parser import parse_query

parse_query('', 3)
{'q': 'wragge',
 'l-artType': 'newspapers',
 'l-state': ['Queensland'],
 'l-category': ['Article'],
 'l-illustrated': 'true',
 'l-illustrationType': ['Cartoon'],
 'category': 'newspaper'}

See the documentation for a more detailed example.


Currently this only works with the 'Newspapers & Gazettes' category. Other categories may be added in time.

Created by Tim Sherratt (@wragge) for the GLAM Workbench.

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

trove_query_parser-0.2.1.tar.gz (7.6 kB view hashes)

Uploaded source

Built Distribution

trove_query_parser-0.2.1-py3-none-any.whl (5.3 kB view hashes)

Uploaded py3

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