Metadata-Version: 1.1
Name: bagit-profile
Version: 1.0.1
Summary: 
    This module can be used to validate BagitProfiles.
    
Home-page: https://github.com/ruebot/bagit-profiles-validator
Author: Mark Jordan, Nick Ruest
Author-email: mjordan@sfu.ca, ruestn@gmail.com
License: UNKNOWN
Description: Bagit Profile (validator)
        =========================
        
        |Build Status|
        
        Description
        ~~~~~~~~~~~
        
        A simple Python module for validating BagIt profiles. See the `BagIt
        Profiles Specification
        <https://github.com/ruebot/bagit-profiles/blob/master/README.md>`__
        for more information.
        
        This module is intended for use with
        `bagit <https://github.com/edsu/bagit>`__ but does not extend it.
        
        Installation
        ~~~~~~~~~~~~
        
        bagit\_profile.py is a single-file python module that you can drop into
        your project as needed or you can install globally with:
        
        1. ``git clone https://github.com/ruebot/bagit-profiles-validator.git``
        2. ``cd bagit-profiles/python``
        3. ``sudo python setup.py install``
        
        or:
        
        ``pip install bagit_profile``
        
        Usage
        ~~~~~
        
        .. code:: python
        
            import bagit
            import bagit_profile
        
        Instantiate an existing Bag using
        `bagit <https://github.com/edsu/bagit>`__.
        ``python bag = bagit.Bag('mydir')``
        
        Instantiate a profile, supplying its URI.
        ``python my_profile = bagit_profile.Profile('http://example.com/bagitprofile.json')``
        
        Validate 'Serialization' and 'Accept-Serialization'. This must be done
        before .validate(bag) is called. 'mydir' is the path to the Bag.
        
        .. code:: python
        
            if my_profile.validate_serialization('mydir'):
                print "Serialization validates"
            else:
                print "Serialization does not validate"
        
        Validate the rest of the profile.
        
        .. code:: python
        
            if my_profile.validate(bag):
                print "Validates"
            else:
                print "Does not validate"
        
        Or from the commandline:
        
        ``bagit_profile.py 'http://uri.for.profile/profile.json' path/to/bag``
        
        Test suite
        ~~~~~~~~~~
        
        ``python setup.py test``
        
        Development
        ~~~~~~~~~~~
        
        1. `Fork the
           repository <https://help.github.com/articles/fork-a-repo>`__
        2. Do something awesome!
        3. `Submit a pull
           request <https://help.github.com/articles/creating-a-pull-request>`__
           explianing what your code does
        
        License
        ~~~~~~~
        
        .. figure:: http://i.creativecommons.org/p/zero/1.0/88x31.png
           :alt: CC0
        
           CC0
        
        .. |Build Status| image:: https://travis-ci.org/ruebot/bagit-profiles-validator.png
           :target: https://travis-ci.org/ruebot/bagit-profiles-validator
        
Platform: POSIX
Classifier: License :: Public Domain
Classifier: Intended Audience :: Developers
Classifier: Topic :: Communications :: File Sharing
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Filesystems
Classifier: Topic :: Utilities
