Homec4science
Diffusion pybliographer (master) Browse

R3596/doc/reference/Pyblio-module.html
fb50ed06a412master

Last Change
Raw File

Pyblio-module.html
View Options

<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Pyblio</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th bgcolor="#70b0f0" class="navbar-select"
>&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
>pyblio-core 1.3.4</th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
Package&nbsp;Pyblio
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>]&nbsp;|&nbsp;<a href="Pyblio-module.html"
target="_top">no&nbsp;frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== PACKAGE DESCRIPTION ==================== -->
<h1 class="epydoc">Package Pyblio</h1><span class="codelink"><a href="Pyblio-pysrc.html">source&nbsp;code</a></span><br /><br />
A framework for manipulating bibliographic databases.
<h1 class="heading">Definitions</h1>
A database is a set of <a href="Pyblio.Store.Record-class.html"
class="link">Records</a>, which contains <b>typed</b> <a
href="Pyblio.Attribute-module.html" class="link">Attributes</a>. The
definition of the available attributes is done in a <a
href="Pyblio.Schema-module.html" class="link">Schema</a>, which
provides names, types and textual description of the fields.
<h1 class="heading">Getting started</h1>
To create, open and start filling a databases, check the <a
href="Pyblio.Store-module.html" class="link">Pyblio.Store</a>
module.<br /><br />
<!-- ==================== SUBMODULES ==================== -->
<a name="section-Submodules"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Submodules</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Submodules"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr><td class="summary">
<ul class="nomargin">
<li> <strong class="uidlink"><a href="Pyblio.Adapter-module.html">Pyblio.Adapter</a></strong>: <em class="summary">Adapt a database schema to another one.</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.Adapters-module.html">Pyblio.Adapters</a></strong>
<ul>
<li> <strong class="uidlink"><a href="Pyblio.Adapters.PubMed2BibTeX-module.html">Pyblio.Adapters.PubMed2BibTeX</a></strong> </li>
<li> <strong class="uidlink"><a href="Pyblio.Adapters.WOK2BibTeX-module.html">Pyblio.Adapters.WOK2BibTeX</a></strong> </li>
</ul>
</li>
<li> <strong class="uidlink"><a href="Pyblio.Arrays-module.html">Pyblio.Arrays</a></strong>: <em class="summary">Result sets and indexes implemented on top of numpy arrays.</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.Attribute-module.html">Pyblio.Attribute</a></strong>: <em class="summary">Basic data types that can be used as attributes for a <a
href="Pyblio.Store.Record-class.html" class="link">Record</a>.</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.Callback-module.html">Pyblio.Callback</a></strong>: <em class="summary">A generic callback mechanism.</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.Cite-module.html">Pyblio.Cite</a></strong>
<ul>
<li> <strong class="uidlink"><a href="Pyblio.Cite.Citator-module.html">Pyblio.Cite.Citator</a></strong>: <em class="summary">Defines the Citator, a class that glues together every aspect
related to citations.</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.Cite.Style-module.html">Pyblio.Cite.Style</a></strong>
<ul>
<li> <strong class="uidlink"><a href="Pyblio.Cite.Style.Base-module.html">Pyblio.Cite.Style.Base</a></strong>: <em class="summary">Generate citation keys.</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.Cite.Style.BibTeX-module.html">Pyblio.Cite.Style.BibTeX</a></strong> </li>
</ul>
</li>
<li> <strong class="uidlink"><a href="Pyblio.Cite.WP-module.html">Pyblio.Cite.WP</a></strong>: <em class="summary">This module contains bindings for specific Word Processors.</em>
<ul>
<li> <strong class="uidlink"><a href="Pyblio.Cite.WP.File-module.html">Pyblio.Cite.WP.File</a></strong>: <em class="summary">A convenience object to write citations to a plain file.</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.Cite.WP.LyX-module.html">Pyblio.Cite.WP.LyX</a></strong>: <em class="summary">Operations on a running LyX instance.</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.Cite.WP.OpenOffice-module.html">Pyblio.Cite.WP.OpenOffice</a></strong>: <em class="summary">A simple API to cite references in OpenOffice.org</em> </li>
</ul>
</li>
</ul>
</li>
<li> <strong class="uidlink"><a href="Pyblio.Compat-module.html">Pyblio.Compat</a></strong>: <em class="summary">Compatability module</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.Exceptions-module.html">Pyblio.Exceptions</a></strong>: <em class="summary">This module defines some common exceptions</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.External-module.html">Pyblio.External</a></strong>: <em class="summary">Support for queries on external services.</em>
<ul>
<li> <strong class="uidlink"><a href="Pyblio.External.Citeseer-module.html">Pyblio.External.Citeseer</a></strong>: <em class="summary">Citeseer (http://citeseer.ist.psu.edu/) queries</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.External.CrossRef-module.html">Pyblio.External.CrossRef</a></strong>: <em class="summary">An asynchronous query module to get DOI numbers given
publication information.</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.External.HTTP-module.html">Pyblio.External.HTTP</a></strong> </li>
<li> <strong class="uidlink"><a href="Pyblio.External.PubMed-module.html">Pyblio.External.PubMed</a></strong>: <em class="summary">Programmatic access to the PubMed database</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.External.WOK-module.html">Pyblio.External.WOK</a></strong>: <em class="summary">Interface to ISI Web of Knowledge.</em> </li>
</ul>
</li>
<li> <strong class="uidlink"><a href="Pyblio.Format-module.html">Pyblio.Format</a></strong>: <em class="summary">Citation formatting layer.</em>
<ul>
<li> <strong class="uidlink"><a href="Pyblio.Format.Base-module.html">Pyblio.Format.Base</a></strong>: <em class="summary">(Base classes of the formatting code)</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.Format.DSL-module.html">Pyblio.Format.DSL</a></strong>: <em class="summary">Basic syntactic elements used to format a citation.</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.Format.Date-module.html">Pyblio.Format.Date</a></strong>: <em class="summary">Date formatting functions.</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.Format.Generator-module.html">Pyblio.Format.Generator</a></strong>: <em class="summary">A base generator, specialized for every output style.</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.Format.HTML-module.html">Pyblio.Format.HTML</a></strong>: <em class="summary">Transformation of the formatted record into an HTML
representation.</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.Format.Misc-module.html">Pyblio.Format.Misc</a></strong>: <em class="summary">Miscellanous formatting helpers.</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.Format.OpenOffice-module.html">Pyblio.Format.OpenOffice</a></strong> </li>
<li> <strong class="uidlink"><a href="Pyblio.Format.Pages-module.html">Pyblio.Format.Pages</a></strong> </li>
<li> <strong class="uidlink"><a href="Pyblio.Format.Person-module.html">Pyblio.Format.Person</a></strong> </li>
<li> <strong class="uidlink"><a href="Pyblio.Format.S2-module.html">Pyblio.Format.S2</a></strong>: <em class="summary">(Data structures for stage 2 of the formatter)</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.Format.S3-module.html">Pyblio.Format.S3</a></strong>: <em class="summary">(Stage 3 objects, ie abstract representation of the actual
layout)</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.Format.Text-module.html">Pyblio.Format.Text</a></strong>: <em class="summary">Transformation of the formatted record into a textual
representation.</em> </li>
</ul>
</li>
<li> <strong class="uidlink"><a href="Pyblio.I18n-module.html">Pyblio.I18n</a></strong>: <em class="summary">Useful tools related to internationalization issues.</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.Parsers-module.html">Pyblio.Parsers</a></strong>: <em class="summary">Bibliographic database parsers for foreign formats.</em>
<ul>
<li> <strong class="uidlink"><a href="Pyblio.Parsers.Semantic-module.html">Pyblio.Parsers.Semantic</a></strong>: <em class="summary">Parsers for bibliographic formats and specific schemas.</em>
<ul>
<li> <strong class="uidlink"><a href="Pyblio.Parsers.Semantic.BibTeX-module.html">Pyblio.Parsers.Semantic.BibTeX</a></strong> </li>
<li> <strong class="uidlink"><a href="Pyblio.Parsers.Semantic.ISI-module.html">Pyblio.Parsers.Semantic.ISI</a></strong>: <em class="summary">Parser for the ISI format returned by the Web of Knowledge.</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.Parsers.Semantic.PubMed-module.html">Pyblio.Parsers.Semantic.PubMed</a></strong>: <em class="summary">Parser for the XML format returned by PubMed's Web API</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.Parsers.Semantic.WOK-module.html">Pyblio.Parsers.Semantic.WOK</a></strong>: <em class="summary">Parser for the XML format returned by Web of Knowledge
queries.</em> </li>
</ul>
</li>
<li> <strong class="uidlink"><a href="Pyblio.Parsers.Syntax-module.html">Pyblio.Parsers.Syntax</a></strong>: <em class="summary">Syntactic parsers for bibliographic formats.</em>
<ul>
<li> <strong class="uidlink"><a href="Pyblio.Parsers.Syntax.BibTeX-module.html">Pyblio.Parsers.Syntax.BibTeX</a></strong>: <em class="summary">Extension module for BibTeX files</em>
<ul>
<li> <strong class="uidlink"><a href="Pyblio.Parsers.Syntax.BibTeX.Coding-module.html">Pyblio.Parsers.Syntax.BibTeX.Coding</a></strong>: <em class="summary">Handles coding and decoding of LaTeX-escaped characters.</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.Parsers.Syntax.BibTeX.Environ%27-module.html">Pyblio.Parsers.Syntax.BibTeX.Environ'</a></strong>: <em class="summary">Handles decoding of @string substitution and of LaTeX
commands.</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.Parsers.Syntax.BibTeX.Parser-module.html">Pyblio.Parsers.Syntax.BibTeX.Parser</a></strong>: <em class="summary">Stream oriented reading of a BibTeX file, with no actual
semantic operation on the content.</em> </li>
</ul>
</li>
<li> <strong class="uidlink"><a href="Pyblio.Parsers.Syntax.ISI-module.html">Pyblio.Parsers.Syntax.ISI</a></strong>: <em class="summary">Parser for the ISI file format.</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.Parsers.Syntax.RIS-module.html">Pyblio.Parsers.Syntax.RIS</a></strong> </li>
<li> <strong class="uidlink"><a href="Pyblio.Parsers.Syntax.Tagged-module.html">Pyblio.Parsers.Syntax.Tagged</a></strong> </li>
<li> <strong class="uidlink"><a href="Pyblio.Parsers.Syntax.XMLEndNote-module.html">Pyblio.Parsers.Syntax.XMLEndNote</a></strong> </li>
<li> <strong class="uidlink"><a href="Pyblio.Parsers.Syntax.XMLMARC-module.html">Pyblio.Parsers.Syntax.XMLMARC</a></strong> </li>
</ul>
</li>
</ul>
</li>
<li> <strong class="uidlink"><a href="Pyblio.Query-module.html">Pyblio.Query</a></strong>: <em class="summary">Definition of the query language.</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.Registry-module.html">Pyblio.Registry</a></strong>: <em class="summary">Support for RIP files.</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.Schema-module.html">Pyblio.Schema</a></strong>: <em class="summary">Schema definition for a pyblio database.</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.Sort-module.html">Pyblio.Sort</a></strong>: <em class="summary">Definition of the sort language.</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.Store-module.html">Pyblio.Store</a></strong>: <em class="summary">Contains the base classes and interfaces used to define a
database of records.</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.Stores-module.html">Pyblio.Stores</a></strong>: <em class="summary">Available physical stores.</em>
<ul>
<li> <strong class="uidlink"><a href="Pyblio.Stores.bsddbstore-module.html">Pyblio.Stores.bsddbstore</a></strong>: <em class="summary">Store implementation on top of Berkeley DB (&gt;= 4.1)</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.Stores.filestore-module.html">Pyblio.Stores.filestore</a></strong>: <em class="summary">Provides an in-memory store, which can read and save the
database in Pyblio's XML format.</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.Stores.memorystore-module.html">Pyblio.Stores.memorystore</a></strong>: <em class="summary">Provides an UNSAVED in-memory store.</em> </li>
<li> <strong class="uidlink"><a href="Pyblio.Stores.resultset-module.html">Pyblio.Stores.resultset</a></strong>: <em class="summary">Common implementation of in-memory result sets and views.</em> </li>
</ul>
</li>
<li> <strong class="uidlink"><a href="Pyblio.Tools-module.html">Pyblio.Tools</a></strong> </li>
</ul></td></tr>
</table>
<br />
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Functions</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Functions"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="init_logging"></a><span class="summary-sig-name">init_logging</span>(<span class="summary-sig-arg">filename</span>=<span class="summary-sig-default">None</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Pyblio-pysrc.html#init_logging">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Variables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="numeric_version"></a><span class="summary-name">numeric_version</span> = <code title="(1, 3, 4)"><code class="variable-group">(</code>1<code class="variable-op">, </code>3<code class="variable-op">, </code>4<code class="variable-group">)</code></code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="version"></a><span class="summary-name">version</span> = <code title="'1.3.4'"><code class="variable-quote">'</code><code class="variable-string">1.3.4</code><code class="variable-quote">'</code></code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="_inited"></a><span class="summary-name">_inited</span> = <code title="False">False</code>
</td>
</tr>
</table>
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th bgcolor="#70b0f0" class="navbar-select"
>&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
>pyblio-core 1.3.4</th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0beta1 on Thu Sep 13 21:54:18 2007
</td>
<td align="right" class="footer">
<a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie()
// -->
</script>
</body>
</html>
c4science · Help