Skip to main content

A tool for working with archival description for public access.

Project description

description_indexer

A tool for working with archival description for public access. description_indexer reads archival description into a minimalist data model for public-facing archival description.

description_indexer can index directly from the ArchivesSpace API to an Arclight Solr instance using ArchivesSnake and PySolr.

This is still a bit drafty, as its only tested on ASpace v2.8.0 and needs better error handling.

Installation

pip install description_indexer

First, you need to configure ArchivesSnake by creating a ~/.archivessnake.ymlfile with your API credentials as detailed by the ArchivesSnake configuration docs.

Next, you also need a ~/.description_indexer.yml file that lists your Solr URL and the core you want to index to. These can also be overridden with args.

solr_url: http://127.0.0.1:8983/solr
solr_core: blacklight-core
last_query: 0

Indexing from ArchivesSpace API to Arclight

Once description_indexer is set up, you can index from the ASpace API to Arclight using the to-arclight command.

Index by id_0

You can provide one or more IDs to index using a resource's id_0` field

to-arclight --id ua807

to-arclight --id mss123 apap106

Index by URI

You can also use integers from ASpace URIs for resource, such as 263 for https://my.aspace.edu/resources/263

to-arclight --uri 435

to-arclight --uri 1 755

Indexing by modified time

Index collections modified in the past hour: to-arclight --hour

Index collections modified in the past day: to-arclight --today

Index collections modified since las run: to-arclight --new

Deleting collections

You can delete one or more collections using the --delete argument in addition to--id. This uses the Solr document ID, such as apap106 for https://my.arclight.edu/catalog/apap106.

to-arclight --id apap101 apap301 --delete

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

description_indexer-0.0.4.tar.gz (13.3 kB view details)

Uploaded Source

Built Distribution

description_indexer-0.0.4-py3-none-any.whl (14.8 kB view details)

Uploaded Python 3

File details

Details for the file description_indexer-0.0.4.tar.gz.

File metadata

  • Download URL: description_indexer-0.0.4.tar.gz
  • Upload date:
  • Size: 13.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for description_indexer-0.0.4.tar.gz
Algorithm Hash digest
SHA256 6332447de20e7707f8d381b7c4d76dd890300b572110b8402b8407f10767ec20
MD5 31de653e80ae3a3db027b28967678846
BLAKE2b-256 1830a0a79eee8a3301ecbf243e588e485f3271d314655ffff4fbaecff4c47d86

See more details on using hashes here.

File details

Details for the file description_indexer-0.0.4-py3-none-any.whl.

File metadata

File hashes

Hashes for description_indexer-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 1e762828430ce4ece290ba7a3de54ee2d4ad85696d26b06f4d9e49675da35a42
MD5 1aec7194e022ce6a150771d8244ab591
BLAKE2b-256 ee95694ae73027c1ac81b5709dc17da503828f1ffb0153b04765650856925992

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