https://github.com/rockefellerarchivecenter/asterism

Helpers and common patterns used in Project Electron infrastructure.
https://github.com/rockefellerarchivecenter/asterism

project-electron python3

Last synced: about 1 month ago
JSON representation

Helpers and common patterns used in Project Electron infrastructure.

• Host: GitHub
• URL: https://github.com/rockefellerarchivecenter/asterism
• Owner: RockefellerArchiveCenter
• License: mit
• Created: 2019-09-16T23:13:37.000Z (about 5 years ago)
• Default Branch: base
• Last Pushed: 2023-05-01T18:09:54.000Z (over 1 year ago)
• Last Synced: 2024-10-13T04:02:46.033Z (about 1 month ago)
• Topics: project-electron, python3
• Language: Python
• Size: 499 KB
• Stars: 0
• Watchers: 5
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# asterism

Helpers and common patterns used in Project Electron infrastructure. This package is named after a pattern or group of stars that is visually obvious, but not officially recognized as a constellation. Read more about asterisms on [Wikipedia](https://en.wikipedia.org/wiki/Asterism_(astronomy)).

[![Build Status](https://app.travis-ci.com/RockefellerArchiveCenter/asterism.svg?branch=base)](https://app.travis-ci.com/RockefellerArchiveCenter/asterism)

## Setup

Make sure this library is installed:

    $ pip install asterism

## Usage

You can then use `asterism` in your Python scripts and applications by importing it:

    import asterism

### What's here

`bagit_helpers` - contains generic bagit functions to validate and update bags.

`file_helpers` - generic functions for manipulating files and directories, as well as working with ZIP and TAR files.

`models` - a `BasePackage` abstract base model that represents a bag of archival records.

`views` - a `BaseServiceView` and a `RoutineView` which provide abstract wrapping methods for handling JSON requests and responses.

## 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

This code is released under an [MIT License](LICENSE).