eadtoolbox 1.0.0

Users

pip install eadtoolbox

Developers

I recommend that you use virtualenv to isolate your development environment from system Python and any packages that may be installed there.

1. In GitHub, fork the repository

2. Clone your fork:

   git clone git@github.com:<username>/ead-toolbox.git

3. Install dependencies:

   pip install -r requirements.txt

4. Install in develop / editable mode:

   pip install -e .

Command-line

EAD Validation

To validate using the EAD 2002 DTD:

ead-validate FILE [FILE [...]]

The EAD Toolbox currently only supports validation using the EAD 2002 DTD. I hope to add validation using the XSD schema in the near future.

Web-based GUI

The features availble though the commnad-line can also be accessed, and made available to other users over a local network or the web, through the EAD Sandbox application. Run the application using the following command:

ead-sandbox [--hostname=HOSTNAME] [--port=PORT]

This will start a quick demonstration WSGI server (not recommended for production use) to serve the application, and also open the application in a new browser window/tab if possible. If you don’t want the browser window/tab, you can launch the application with the --no-browser option:

ead-sandbox --no-browser [--hostname=HOSTNAME] [--port=PORT]

Python API

EAD Validation

from lxml import etree
from eadtoolbox.validate import EAD2002DTDValidator
ead = etree.parse(open('eadfile.xml', 'r'))
validator = EAD2002DTDValidator()
if validator.validate(ead):
    print "VALID"
else:
    print "INVALID"
    for e in validator.errors:
        print str(e)