https://github.com/rockefellerarchivecenter/aquila

An application to store, calculate, and assign PREMIS rights statements.
https://github.com/rockefellerarchivecenter/aquila

project-electron

Last synced: 1 day ago
JSON representation

An application to store, calculate, and assign PREMIS rights statements.

• Host: GitHub
• URL: https://github.com/rockefellerarchivecenter/aquila
• Owner: RockefellerArchiveCenter
• License: mit
• Created: 2020-06-23T18:49:48.000Z (over 4 years ago)
• Default Branch: base
• Last Pushed: 2024-04-10T18:56:30.000Z (7 months ago)
• Last Synced: 2024-04-10T21:57:16.134Z (7 months ago)
• Topics: project-electron
• Language: Python
• Homepage:
• Size: 612 KB
• Stars: 0
• Watchers: 5
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# aquila

An application to store, calculate, and assign PREMIS rights statements.

## Getting Started

Install [git](https://git-scm.com/) and clone the repository

    $ git clone https://github.com/RockefellerArchiveCenter/aquila.git

Install [Docker](https://store.docker.com/search?type=edition&offering=community) and run docker-compose from the root directory

    $ cd aquila

    $ docker-compose up

A default user with username `test` and password `testpassword` is created on setup. Once the application starts successfully, you should be able to access the application in your browser at `http://localhost:8009`.

When you're done, shut down docker-compose

    $ docker-compose down

Or, if you want to remove all data

    $ docker-compose down -v

## Default Superuser

When you start the container for the first time, a superuser will be created. Make sure you change the password for this user (the easiest way is through the Django shell). E.g.,

```

python manage.py changepassword 

```

## Usage

Aquila includes a front-end interface to create rights statements and groupings, as well as an API to assemble rights statements.

Groupings are groups of content that have similar rights. They may correspond to record types, collections, or projects.

The rights statements contain date rules that are calculated by the Rights Assembler API. Many rights statements can be attached to many groupings.

### API

Aquila contains a Rights Assembler API (available at `api/rights-assemble/`), which uses a start date, an end date, and IDs of rights statements to create rights JSON.

## Requirements

Using this repo requires having [Docker](https://store.docker.com/search?type=edition&offering=community) installed.

## Development

This repository contains a configuration file for git [pre-commit](https://pre-commit.com/) 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

Code is released under an MIT License, as all your code should be. See [LICENSE](LICENSE) for details.