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
Metadata
Release files for description-indexer 0.0.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| description_indexer-0.0.4.tar.gz | 13.3 kB | Without provenance | Details for description_indexer-0.0.4.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| description_indexer-0.0.4-py3-none-any.whl | Python 3 | none | any | Details for description_indexer-0.0.4-py3-none-any.whl |
Total release size: 28.1 kB
Release files / description_indexer-0.0.4.tar.gz
| Download URL | description_indexer-0.0.4.tar.gz |
|---|---|
| Size | 13.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6332447de20e7707f8d381b7c4d76dd890300b572110b8402b8407f10767ec20
|
|
BLAKE2b-256 checksum How to use checksums |
1830a0a79eee8a3301ecbf243e588e485f3271d314655ffff4fbaecff4c47d86
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.13
|
Release files / description_indexer-0.0.4-py3-none-any.whl
| Download URL | description_indexer-0.0.4-py3-none-any.whl |
|---|---|
| Size | 14.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1e762828430ce4ece290ba7a3de54ee2d4ad85696d26b06f4d9e49675da35a42
|
|
BLAKE2b-256 checksum How to use checksums |
ee95694ae73027c1ac81b5709dc17da503828f1ffb0153b04765650856925992
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.13
|
Security for description-indexer 0.0.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.