edpop-explorer 0.4.2

Common interface to multiple library catalogues and bibliographical databases

edpop-explorer

Common interface to multiple library catalogues and bibliographical databases with convenience commandline tool, created for the EDPOP virtual research environment.

Install

To install locally, type (inside or outside a virtual environment):

# pip install .

The tool can then be run using the edpopx command. (On Windows it may be that the edpopx command does not become available on the path. In that case you can also run it using the command python -m edpop_explorer.)

For development purposes it may be better to use the --editable option:

# pip install --editable .

This way, the source code will be read directly from the original directory when running the application and changes will have immediate effect.

Usage

(This section documents the commandline tool.

Start the programme from the command line using the edpopx command:

$ edpopx

To perform a search on a database, give the name of the database followed by the query you want to perform, such as:

# hpb gruninger

This will give you the number of results and a summary of the first ten results. To load more results, use the next command:

# next

The results are numbered. Use the show command to see the contents of a particular record:

# show 8

To exit, type Ctrl+D or use the quit command:

# quit

Design

The commandline programme in __main__.py uses the common interface of the APIReader and APIRecord classes to query the various databases that EDPOP is ought to support. Interfaces to concrete APIs, such as Gallica and HPB, are defined using classes that inherit from these two classes.

Class hierarcy (interfaces to concrete APIs are in bold -- these are located in the readers subpackage):

• APIReader / APIRecord
  • SRUReader
    • GallicaReader / GallicaRecord
    • CERLThesaurusReader / CERLThesaurusRecord
    • BibliopolisReader / BibliopolisRecord
    • KBReader / KBRecord
    • SRUMarc21Reader / Marc21Record
      • HPBReader
      • VD16Reader
      • VD17Reader
      • VD18Reader
      • BnFReader
  • SparqlReader / SparqlRecord
    • STCNReader
  • SBTIReader / SBTIRecord
  • FBTEEReader / FBTEERecord
  • USTCReader / USTCRecord