Metadata-Version: 2.4
Name: alephmarcreader
Version: 1.0.0
Summary: A package to read Marc data obtained from Aleph, the catalogue of the library of the University of Basel
Home-page: https://github.com/dhlab-basel/alephmarcreader.git
Author: Tobias Schweizer, Digital Humanities Lab, University of Basel; Balduin Landolt, University of Basel
Author-email: t.schweizer@unibas.ch
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: summary

# alephmarcreader
## General 
Python library to read Marc obtained from Aleph, the catalogue of the library of the University of Basel.

This library supports Marc21, MARCXML, and AlephX.

## Documentation
The docstrings can be displayed with pydoc (from the project root): `pydoc alephmarcreader.abstractalephmarcreader.AbstractAlephMarcReader
`. For the inner classes such as `Person`, run `pydoc alephmarcreader.abstractalephmarcreader.AbstractAlephMarcReader.Person`.

## Design
`alephmarcreader.abstractalephmarcreader.AbstractAlephMarcReader` provides methods to access Marc data.
It is an abstract class that has two abstract methods `__get_field` and `__get_subfield_text` that have to be implemented in the subclass for the file format at hand.

## Unit Tests

From the project root, run `python -m unittest alephmarcreader.tests.test_[Marc[21|XML]|X]Reader`.

## Dependencies

- `pymarc`: install with pip
- `lxml`: install with pip

The library works both with python2 and python3.
