{ "info": { "author": "John Harrison", "author_email": "john.harrison@liv.ac.uk", "bugtrack_url": null, "classifiers": [ "Intended Audience :: Developers", "Intended Audience :: Information Technology", "License :: OSI Approved :: BSD License", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Topic :: Internet :: WWW/HTTP :: WSGI :: Application", "Topic :: Text Processing :: Markup" ], "description": "EAD Toolbox\r\n===========\r\n\r\n26th September 2013 (2013-09-26)\r\n\r\nContents\r\n--------\r\n\r\n- `Description`_\r\n- `Author(s)`_\r\n- `Latest Version`_\r\n- `Documentation`_\r\n- `Requirements / Dependencies`_\r\n- `Installation`_\r\n- `Examples`_\r\n\r\n - `Command-line`_\r\n - `Web-based GUI`_\r\n - `Python API`_\r\n\r\n- `Bugs, Feature requests etc.`_\r\n- `Copyright & Licensing`_\r\n \r\n\r\nDescription\r\n-----------\r\n\r\nThe EAD Toolbox provides a number of tools for working with `Encoded Archival \r\nDescription`_ (EAD) XML documents.\r\n\r\nCurrent capabilities include validation to the DTD, cross-walk to other \r\nmetadata schemas, and extraction and display of subjects and named entities.\r\n\r\nIt also includes a web-based user interface for validating, cross-walking and\r\nextracting data from your own EAD files, provided via a Python_ WSGI_ compliant\r\nweb application\r\n\r\n\r\nAuthor(s)\r\n---------\r\n\r\nJohn Harrison at the `University of Liverpool`_ \r\n\r\n\r\nLatest Version\r\n--------------\r\n\r\nLatest version is available from PyPI:\r\nhttps://pypi.python.org/pypi/eadtoolbox\r\n\r\nSource code is under version control and available from:\r\nhttps://github.com/bloomonkey/ead-toolbox\r\n\r\n\r\nDocumentation\r\n-------------\r\n\r\nAll executable commands are self documenting, i.e. you can get help on how to\r\nuse them with the ``-h`` or ``--help`` option. e.g. ::\r\n\r\n ead-validate --help\r\n\r\nAt this time the only additional documentation that exists can be found in this\r\nREADME file!\r\n\r\n\r\nRequirements / Dependencies\r\n---------------------------\r\n\r\n- Python_ >= 2.6\r\n- lxml_\r\n\r\n\r\nInstallation\r\n------------\r\n\r\nUsers\r\n~~~~~\r\n\r\n::\r\n\r\n pip install eadtoolbox\r\n\r\n\r\nDevelopers\r\n~~~~~~~~~~\r\n\r\nI recommend that you use virtualenv_ to isolate your development environment\r\nfrom system Python_ and any packages that may be installed there.\r\n\r\n1. In GitHub_, fork the repository\r\n\r\n2. Clone your fork::\r\n\r\n git clone git@github.com:/ead-toolbox.git\r\n\r\n3. Install dependencies::\r\n\r\n pip install -r requirements.txt\r\n\r\n4. Install in develop / editable mode::\r\n\r\n pip install -e .\r\n\r\n\r\nExamples\r\n--------\r\n\r\nCommand-line\r\n~~~~~~~~~~~~\r\n\r\nEAD Validation\r\n''''''''''''''\r\n\r\nTo validate using the EAD 2002 DTD::\r\n\r\n ead-validate FILE [FILE [...]]\r\n\r\nThe EAD Toolbox currently only supports validation using the EAD 2002 DTD. I\r\nhope to add validation using the XSD schema in the near future. \r\n\r\n\r\nWeb-based GUI\r\n~~~~~~~~~~~~~\r\n\r\nThe features availble though the commnad-line can also be accessed, and made\r\navailable to other users over a local network or the web, through the EAD\r\nSandbox application. Run the application using the following command::\r\n\r\n ead-sandbox [--hostname=HOSTNAME] [--port=PORT]\r\n\r\n\r\nThis will start a quick demonstration WSGI server (not recommended for\r\nproduction use) to serve the application, and also open the application in a\r\nnew browser window/tab if possible. If you don't want the browser window/tab,\r\nyou can launch the application with the ``--no-browser`` option::\r\n\r\n ead-sandbox --no-browser [--hostname=HOSTNAME] [--port=PORT]\r\n\r\n\r\nPython API\r\n~~~~~~~~~~\r\n\r\nEAD Validation\r\n''''''''''''''\r\n\r\n.. code-block:: python\r\n\r\n from lxml import etree\r\n from eadtoolbox.validate import EAD2002DTDValidator\r\n ead = etree.parse(open('eadfile.xml', 'r'))\r\n validator = EAD2002DTDValidator()\r\n if validator.validate(ead):\r\n print \"VALID\"\r\n else:\r\n print \"INVALID\"\r\n for e in validator.errors:\r\n print str(e)\r\n\r\n\r\nBugs, Feature requests etc.\r\n---------------------------\r\n\r\nBug reports and feature requests can be submitted to the GitHub issue tracker:\r\nhttp://github.com/bloomonkey/ead-toolbox/issues\r\n\r\nIf you'd like to contribute code, patches etc. please email the author, or\r\nsubmit a pull request on GitHub.\r\n\r\n\r\nCopyright & Licensing\r\n---------------------\r\n\r\nCopyright (c) University of Liverpool, 2010-2013\r\n\r\nSee LICENSE.rst for licensing details.\r\n\r\n\r\n.. Links\r\n.. _Python: http://www.python.org/\r\n.. _WSGI: http://wsgi.org\r\n.. _lxml: https://pypi.python.org/pypi/lxml\r\n.. _`Encoded Archival Description`: http://www.loc.gov/ead/\r\n.. _`University of Liverpool`: http://www.liv.ac.uk\r\n.. _GitHub: http://github.com\r\n.. _virtualenv: http://www.virtualenv.org/en/latest/", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/bloomonkey/ead-toolbox", "keywords": "", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "eadtoolbox", "package_url": "https://pypi.org/project/eadtoolbox/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/eadtoolbox/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://github.com/bloomonkey/ead-toolbox" }, "release_url": "https://pypi.org/project/eadtoolbox/1.0.0/", "requires_dist": null, "requires_python": null, "summary": "Tools for working with EAD XML files.", "version": "1.0.0" }, "last_serial": 874701, "releases": { "0.1c1": [ { "comment_text": "", "digests": { "md5": "b92381b1c557034aa2ee61a7bb2055d5", "sha256": "809a2d37ae7c7bceccf7836e5c2639a184c2dbcc2747f3ac334ed2fd5ae82205" }, "downloads": -1, "filename": "eadtoolbox-0.1c1.tar.gz", "has_sig": false, "md5_digest": "b92381b1c557034aa2ee61a7bb2055d5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 39604, "upload_time": "2013-01-31T15:31:52", "url": "https://files.pythonhosted.org/packages/4c/b9/4ed948ee745b04394081cd6aa51db623183a4066eecc326ad6598c2853c4/eadtoolbox-0.1c1.tar.gz" } ], "1.0.0": [ { "comment_text": "", "digests": { "md5": "b93ee423d1d76aaaba41ce6be60aebee", "sha256": "36e77fc2f2a4af3591dfb1c670475025bbc991ec20521b696127351f5ad8f57c" }, "downloads": -1, "filename": "eadtoolbox-1.0.0.tar.gz", "has_sig": false, "md5_digest": "b93ee423d1d76aaaba41ce6be60aebee", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 41558, "upload_time": "2013-09-26T14:50:11", "url": "https://files.pythonhosted.org/packages/6f/0a/c7fb5e201e71f656ebc03bb748d84b1290bb16e2f2a641ffb3ef96db9f0f/eadtoolbox-1.0.0.tar.gz" } ], "1.0.0c1": [] }, "urls": [ { "comment_text": "", "digests": { "md5": "b93ee423d1d76aaaba41ce6be60aebee", "sha256": "36e77fc2f2a4af3591dfb1c670475025bbc991ec20521b696127351f5ad8f57c" }, "downloads": -1, "filename": "eadtoolbox-1.0.0.tar.gz", "has_sig": false, "md5_digest": "b93ee423d1d76aaaba41ce6be60aebee", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 41558, "upload_time": "2013-09-26T14:50:11", "url": "https://files.pythonhosted.org/packages/6f/0a/c7fb5e201e71f656ebc03bb748d84b1290bb16e2f2a641ffb3ef96db9f0f/eadtoolbox-1.0.0.tar.gz" } ] }