bagit-profiles-validator

KO | EN

gitlite — search

#dotfiles #vim #ruby #python #java #plugin #mantisbt-plugin #javascript #php #ai-agent #nodejs #adopt-this-plugin

bagit-profiles-validator

★ 12 Open GitHub ↗

A simple Python module for validating BagIt Profiles.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Bagit Profile (validator)

[![PyPI version](https://img.shields.io/pypi/v/bagit_profile.svg)](https://pypi.org/project/bagit_profile)
[![Build Status](https://travis-ci.com/bagit-profiles/bagit-profiles-validator.svg?branch=master)](https://travis-ci.com/bagit-profiles/bagit-profiles-validator)
[![codecov](https://codecov.io/gh/bagit-profiles/bagit-profiles-validator/branch/master/graph/badge.svg)](https://codecov.io/gh/bagit-profiles/bagit-profiles-validator)

### Description

A simple Python module for validating [BagIt](https://tools.ietf.org/html/rfc8493) Profiles. See the [BagIt Profiles Specification (draft)](https://github.com/bagit-profiles/bagit-profiles/blob/master/README.md) for more information.

This module is intended for use with [bagit-python](https://github.com/LibraryOfCongress/bagit-python) 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/bagit-profiles/bagit-profiles-validator.git`
2. `cd bagit-profiles-validator`
3. `sudo python setup.py install`

or:

```pip install bagit_profile```

### Usage

```python
import bagit
import bagit_profile
```

Instantiate an existing Bag using [bagit-python](https://github.com/LibraryOfCongress/bagit-python).
```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.

```python
if my_profile.validate_serialization('mydir'):
    print "Serialization validates"
else:
    print "Serialization does not validate"
```

Validate the rest of the profile.

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

![CC0](http://i.creativecommons.org/p/zero/1.0/88x31.png "CC0")

bagit-profiles-validator

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README