Metadata-Version: 2.1
Name: ammcpc
Version: 0.1.3
Summary: Python command line wrapper around MediaConch policy checks.
Home-page: UNKNOWN
Author: Artefactual
Author-email: info@artefactual.com
License: AGPL
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: lxml

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

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.


.. class:: no-web no-pdf

|build|


Install with Pip::

    $ pip install ammcpc

Install from source::

    $ python setup.py install

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')

System dependencies:

- MediaConch version 16.12

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

    $ tox


.. |build|  image:: https://travis-ci.org/artefactual-labs/ammcpc.svg?branch=master
    :target: https://travis-ci.org/artefactual-labs/ammcpc
    :alt: Build status of the master branch