Validator for digitized assets produced through internal processes.
If you have git and Docker installed, using this repository is as simple as:
git clone https://github.com/RockefellerArchiveCenter/internal_digitization_validation.git
cd internal_digitization_validation
docker build -t internal_digitization_validation .
docker run internal_digitization_validation
This repository is intended to be deployed as an ECS Task in AWS or local infrastructure.
This code is released under the MIT License.
This is an open source project and we welcome contributions! If you want to fix a bug, or have an idea of how to enhance the application, the process looks like this:
- File an issue in this repository. This will provide a location to discuss proposed implementations of fixes or enhancements, and can then be tied to a subsequent pull request.
- If you have an idea of how to fix the bug (or make the improvements), fork the repository and work in your own branch. When you are done, push the branch back to this repository and set up a pull request. Automated unit tests are run on all pull requests. Any new code should have unit test coverage, documentation (if necessary), and should conform to the Python PEP8 style guidelines.
- After some back and forth between you and core committers (or individuals who have privileges to commit to the base branch of this repository), your code will probably be merged, perhaps with some minor changes.
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.
New code should have unit tests. Tests can be run using tox.