Skip to content

Archivematica MediaConch policy check wrapper

License

Notifications You must be signed in to change notification settings

artefactual-labs/ammcpc

Repository files navigation

ammcpc --- Archivematica (AM) MediaConch (MC) Policy Checker (PC)

PyPI version GitHub CI codecov

This command-line application and python module is a simple wrapper around the MediaConch tool which takes a file and a MediaConch policy file as input and prints to stdout a JSON object indicating, in a way that Archivematica likes, whether the file passes the policy check.

Installation

Install with pip:

    pip install ammcpc

Install from source:

    python setup.py install

Usage

Command-line usage:

    ammcpc <PATH_TO_FILE> <PATH_TO_POLICY>

Python usage with a policy file path:

    >>> from ammcpc import MediaConchPolicyCheckerCommand
    >>> policy_checker = MediaConchPolicyCheckerCommand(
            policy_file_path='/path/to/my-policy.xml')
    >>> exitcode = policy_checker.check('/path/to/file.mkv')

Python usage with a policy as a string:

    >>> policy_checker = MediaConchPolicyCheckerCommand(
            policy='<?xml><policy> ... </policy>',
            policy_file_name='my-policy.xml')
    >>> exitcode = policy_checker.check('/path/to/file.mkv')

Requirements

System dependencies:

  • MediaConch version 16.12

Testing

To run the tests, make sure tox is installed, then:

    tox