E-Deposit AMQP module providing communication with Aleph
Project description
Introduction
This package provides an AMQP middle-ware for communication with Aleph. Aleph is a system used in libraries to store meta-data about books and authors.
You can read some documentation, but that is based on acceptance test and it’s not really actual.
Full documentation can be found in doc-strings of each .py source file. Full Sphinx documentation of source codes will provided to the end of this week.
Installation
Module is hosted at PYPI, and can be easily installed using PIP:
pip install edeposit.amqp.aleph
Sources can be found at GitHub: https://github.com/jstavel/edeposit.amqp.aleph.
Content
Module provides several submodules:
edeposit.amqp.aleph.__init__
Data structures for (generic, not just AMQP) communication. It contains reaction function reactToAMQPMessage(), which detects what (serialized) structure was given to her, do some low-level interactions with Aleph and returns result structures.
Module provides also serialize/deserialze functions for generic python namedtuple structures.
edeposit.amqp.aleph.aleph
Used for raw communication with Aleph server. Communication is read-only and uses special API provided by Aleph X-Services module.
Can be queried using reactToAMQPMessage() defined in __init__.
edeposit.amqp.aleph.marcxml
MARC XML (de)serialization class, which provides some higher-level bindings to MARC records.
edeposit.amqp.aleph.convertors
Convertors from MARC XML records to Epublication structures defined in __init__.
edeposit.amqp.aleph.isbn
ISBN checksum validator.
Can be queried using reactToAMQPMessage() defined in __init__.
Acceptance tests
Robot Framework is used to test the sources, which are stored in src/edeposit/amqp/aleph/tests directory.
You can run them manually (from the root of the package):
$ pybot -W 100 --pythonpath src/edeposit/amqp/aleph/tests/:src src/edeposit/amqp/aleph/tests/
Or continuously using nosier:
$ nosier -p src -b 'export' "pybot -W 100 --pythonpath src/edeposit/amqp/aleph/tests/ --pythonpath src src/edeposit/amqp/aleph/tests/"
Status of acceptance tests
You can see the results of the tests here:
http://edeposit-amqp-aleph.readthedocs.org/cs/latest/_downloads/log.html
http://edeposit-amqp-aleph.readthedocs.org/cs/latest/_downloads/report.html
Results are currently (04.03.2014) outdated, but some form of continuous integration framework will be used in the future.
Contributors
Jan Stavel <stavel.jan@gmail.com>, Tester
Bystroushaak <bystrousak@kitakitsune.org>, Developer
Changelog
1.2.1
All source files are now documented with google style docstrings.
1.2.0
Added experimental export support.
1.1.0
Project released at PYPI.
1.0 (unreleased)
Communication with Aleph is now working.
0.1-dev (unreleased)
Package created using templer.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for edeposit.amqp.aleph-1.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc5e737a4ef6aade3e465e5be7ed37d4581d60811ac22591099cad88b2742b21 |
|
MD5 | 5418f6e58b9a54c40f9877bd1ddc94d9 |
|
BLAKE2b-256 | 524612d64fbe04e525316c85cd14b34d7e5ef4da8fb490b7371ab9ee67cd03ab |