Skip to content

Latest commit

 

History

History
77 lines (48 loc) · 3.39 KB

README.md

File metadata and controls

77 lines (48 loc) · 3.39 KB
Raw

aquarius

A microservice to transform and deliver Accessions, Archival Objects and Digital Objects to ArchivesSpace.

aquarius is part of Project Electron, an initiative to build sustainable, open and user-centered infrastructure for the archival management of digital records at the Rockefeller Archive Center.

Setup

Install git and clone the repository

$ git clone [email protected]:RockefellerArchiveCenter/aquarius.git

Install Docker and run docker-compose from the root directory

$ cd aquarius
$ docker-compose up

Once the application starts successfully, you should be able to access the application in your browser at http://localhost:8000

When you're done, shut down docker-compose

$ docker-compose down

Or, if you want to remove all data

$ docker-compose down -v

Configuration

You will need to edit configuration values in aquarius/config.py to point to your instance of ArchivesSpace.

Services

aquarius has seven services, all of which are exposed via HTTP endpoints (see Routes section below):

  • Store Packages - saves package data received via a POST request. For an example of the package data aquarius expects, see fixtures/data/.
  • Transform Accessions - transforms accession data and delivers it to ArchivesSpace as an accession.
  • Transform Grouping Components - transforms accession data into a grouping component and delivers it to ArchivesSpace as an archival object.
  • Transform Transfer Component - transforms transfer data and delivers it to ArchivesSpace as an archival object.
  • Transform Digital Component - transforms transfer data and delivers it to ArchivesSpace as a digital object.
  • Update Accession Status - sends updated accession data to Aurora.
  • Update Transfer Status - sends updated transfer data to Aurora.

Routes

Method URL Parameters Response Behavior
POST /packages 200 Saves new package objects
GET /packages 200 Returns a list of packages
GET /packages/{id} 200 Returns data about an individual package
POST /accessions 200 Runs the AccessionRoutine process
POST /grouping-components 200 Runs the GroupingComponentRoutine process
POST /transfer-components 200 Runs the TransferComponentRoutine process
POST /digital-objects 200 Runs the DigitalObjectRoutine process
POST /send-update 200 Sends updated transfer data to Aurora
POST /send-accession-update 200 Sends updated accession data to Aurora
GET /status 200 Return the status of the microservice

ArchivesSpace configuration

In order to successfully save data to ArchivesSpace, you will have to make some changes to some of the default enumerations:

  • Accession Acquisition Type: add donation
  • Extent Extent Type: add bytes and files
  • File Version Use Statement: add master and service-edited
  • Rights Statement Acts: add publish

Development

This repository contains a configuration file for git pre-commit hooks which help ensure that code is linted before it is checked into version control. It is strongly recommended that you install these hooks locally by installing pre-commit and running pre-commit install.

License

This code is released under an MIT License.