Metadata-Version: 1.1
Name: pybibframe
Version: 0.4.5
Summary: Python tools for BIBFRAME (Bibliographic Framework), a Web-friendly framework for bibliographic descriptions in libraries, for example.
Home-page: http://zepheira.com/
Author: Zepheira
Author-email: uche@zepheira.com
License: License :: OSI Approved :: Apache Software License
Description: pybibframe
        ==========
        
        Requires Python 3.4 or more recent. To install dependencies:
        
        ::
        
            pip install -r requirements.txt
        
        Then install pybibframe:
        
        ::
        
            python setup.py install
        
        Usage
        =====
        
        Converting MARC/XML to RDF or Versa output (command line)
        ---------------------------------------------------------
        
        Note: Versa is a model for Web resources and relationships. Think of it
        as an evolution of Resource Description Framework (RDF) that’s at once
        simpler and more expressive. It’s the default internal representation
        for PyBibframe, though regular RDF is an optional output.
        
        ::
        
            marc2bf records.mrx
        
        Reads MARC/XML from the file records.mrx and outputs a Versa
        representation of the resulting BIBFRAME records in JSON format. You can
        send that output to a file as well:
        
        ::
        
            marc2bf -o resources.versa.json records.mrx
        
        The Versa representation is the primary format for ongoing, pipeline
        processing.
        
        If you want an RDF/Turtle representation of this file you can do:
        
        ::
        
            marc2bf -o resources.versa.json --rdfttl resources.ttl records.mrx
        
        If you want an RDF/XML representation of this file you can do:
        
        ::
        
            marc2bf -o resources.versa.json --rdfxml resources.rdf records.mrx
        
        You can get the source from standard input:
        
        ::
        
            curl http://lccn.loc.gov/2006013175/marcxml | marc2bf -c /Users/uche/dev/zepheira/pybibframe-plus/test/resource/config1.json --mod=bibframe.zextra -o /tmp/marc2bf.versa.json
        
        .. raw:: html
        
           <!--
               See also Das Innere des Glaspalastes in London from one of Eric Miller's favorite examples
               curl http://lccn.loc.gov/2012659481/marcxml | marc2bf -c /Users/uche/dev/zepheira/pybibframe-plus/test/resource/config1.json --mod=bibframe.zextra -o /tmp/marc2bf.versa.json
           -->
        
        (Pulling a record from the Web, in particular Library of Congress Online
        Catalog / LCCN Permalink)
        
        You can process more than one MARC/XML file at a time by listing them on
        the command line:
        
        ::
        
            marc2bf records1.mrx records2.mrx records3.mrx
        
        Or by using wildcards:
        
        ::
        
            marc2bf records?.mrx
        
        PyBibframe is highly extensible, and you can specify plug-ins from the
        command line. You need to specify the Python module from which the
        plugins can be imported and a configuration file specifying how the
        plugins are to be used. For example, to use the ``linkreport`` plugin
        that comes with PyBibframe you can do:
        
        ::
        
            marc2bf -c config1.json --mod=bibframe.plugin records.mrx
        
        Where the contents of config1.json might be:
        
        ::
        
            {
                "plugins": [
                    {"id": "https://github.com/uogbuji/pybibframe#linkreport",
                    "output-file": "linkreport.html"}
                ]
            }
        
        Which in this case will generate, in addition to the regular outputs
        will create a file named ``linkreport.html`` listing any resource fields
        in the form of URIs.
        
        Converting MARC/XML to RDF or Versa output (API)
        ================================================
        
        The ``bibframe.reader.marcxml.bfconvert`` method can be used from APIs
        etc to run the conversion.
        
        ::
        
            >>> from bibframe.reader.marcxml import bfconvert
            >>> inputs = open('records.mrx', 'r')
            >>> out = open('resorces.versa.json', 'w')
            >>> bfconvert(inputs=inputs, base='http://example.org', out=out)
        
        See also
        ========
        
        Some open-source tools for working with BIBFRAME (see
        http://bibframe.org)
        
        Note: very useful to have around yaz-marcdump (which e.g. you can use to
        conver other MARC formats to MARC/XML)
        
        Download from http://ftp.indexdata.com/pub/yaz/ , unpack then do:
        
        $ ./configure –prefix=$HOME/.local $ make && make install
        
        `MarcEdit`_ can also convert to MARC/XML. Just install, select “MARC
        Tools” from the menu, choose your input file, specify an output file,
        and specify the conversion you need to perform, e.g. “MARC21->MARC21XML”
        for MARC to MARC/XML. Note the availability of the UTF-8 output option
        too.
        
        .. _MarcEdit: http://marcedit.reeset.net/
        
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Database
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Text Processing :: Markup :: XML
Classifier: Topic :: Text Processing :: Indexing
Classifier: Topic :: Utilities
