Page MenuHomec4science

Pyblio-module.html
No OneTemporary

File Metadata

Created
Fri, Jul 4, 14:17

Pyblio-module.html

<?xml version="1.0" encoding="iso-8859-1"?>
<!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"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th bgcolor="#70b0f0" class="navselect">&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>
<th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
pybliographer&nbsp;1.3.3
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
Package&nbsp;Pyblio
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[show&nbsp;private&nbsp;|&nbsp;<a href="../public/Pyblio-module.html">hide&nbsp;private</a>]</font></td></tr>
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="Pyblio-module.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF PACKAGE DESCRIPTION =========== -->
<h2 class="package">Package Pyblio</h2>
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"><code>Records</code></a>, which contains <b>typed</b> <a
href="Pyblio.Attribute-module.html"
class="link"><code>Attributes</code></a>. The definition of the
available attributes is done in a <a href="Pyblio.Schema-module.html"
class="link"><code>Schema</code></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"><code>Pyblio.Store</code></a> module.
<hr/>
<!-- =========== START OF SUBMODULES =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Submodules</th></tr>
<tr><td><ul>
<li> <b><a href="Pyblio.Adapter-module.html"><code>Adapter</code></a></b>: <i>Adapt a database schema to another one.</i>
<li> <b><a href="Pyblio.Adapters-module.html"><code>Adapters</code></a></b>
<ul>
<li> <b><a href="Pyblio.Adapters.PubMed2BibTeX-module.html"><code>PubMed2BibTeX</code></a></b>
</ul>
<li> <b><a href="Pyblio.Arrays-module.html"><code>Arrays</code></a></b>: <i>Result sets and indexes implemented on top of numpy arrays.</i>
<li> <b><a href="Pyblio.Attribute-module.html"><code>Attribute</code></a></b>: <i>Basic data types that can be used as attributes for a <a
href="Pyblio.Store.Record-class.html"
class="link"><code>Record</code></a>.</i>
<li> <b><a href="Pyblio.Callback-module.html"><code>Callback</code></a></b>: <i>A generic callback mechanism.</i>
<li> <b><a href="Pyblio.Cite-module.html"><code>Cite</code></a></b>
<ul>
<li> <b><a href="Pyblio.Cite.Citator-module.html"><code>Citator</code></a></b>: <i>Defines the Citator, a class that glues together every aspect related
to citations.</i>
<li> <b><a href="Pyblio.Cite.Style-module.html"><code>Style</code></a></b>
<ul>
<li> <b><a href="Pyblio.Cite.Style.Base-module.html"><code>Base</code></a></b>: <i>Generate citation keys.</i>
<li> <b><a href="Pyblio.Cite.Style.BibTeX-module.html"><code>BibTeX</code></a></b>
</ul>
<li> <b><a href="Pyblio.Cite.WP-module.html"><code>WP</code></a></b>: <i>This module contains bindings for specific Word Processors.</i>
<ul>
<li> <b><a href="Pyblio.Cite.WP.File-module.html"><code>File</code></a></b>: <i>A convenience object to write citations to a plain file.</i>
<li> <b><a href="Pyblio.Cite.WP.LyX-module.html"><code>LyX</code></a></b>: <i>Operations on a running LyX instance.</i>
<li> <b><a href="Pyblio.Cite.WP.OpenOffice-module.html"><code>OpenOffice</code></a></b>: <i>A simple API to cite references in OpenOffice.org</i>
</ul>
</ul>
<li> <b><a href="Pyblio.Exceptions-module.html"><code>Exceptions</code></a></b>: <i>This module defines some common exceptions</i>
<li> <b><a href="Pyblio.External-module.html"><code>External</code></a></b>: <i>Support for queries on external services.</i>
<ul>
<li> <b><a href="Pyblio.External.CrossRef-module.html"><code>CrossRef</code></a></b>: <i>An asynchronous query module to get DOI numbers given publication
information.</i>
<li> <b><a href="Pyblio.External.HTTP-module.html"><code>HTTP</code></a></b>
<li> <b><a href="Pyblio.External.PubMed-module.html"><code>PubMed</code></a></b>: <i>Programmatic access to the PubMed database</i>
<li> <b><a href="Pyblio.External.WOK-module.html"><code>WOK</code></a></b>: <i>Interface to ISI Web of Knowledge.</i>
</ul>
<li> <b><a href="Pyblio.Format-module.html"><code>Format</code></a></b>: <i>Citation formatting layer.</i>
<ul>
<li> <b><a href="Pyblio.Format.Base-module.html"><code>Base</code></a></b>: <i>(Base classes of the formatting code)</i>
<li> <b><a href="Pyblio.Format.Date-module.html"><code>Date</code></a></b>: <i>Date formatting functions.</i>
<li> <b><a href="Pyblio.Format.DSL-module.html"><code>DSL</code></a></b>: <i>Basic syntactic elements used to format a citation.</i>
<li> <b><a href="Pyblio.Format.Generator-module.html"><code>Generator</code></a></b>: <i>A base generator, specialized for every output style.</i>
<li> <b><a href="Pyblio.Format.HTML-module.html"><code>HTML</code></a></b>: <i>Transformation of the formatted record into an HTML
representation.</i>
<li> <b><a href="Pyblio.Format.Misc-module.html"><code>Misc</code></a></b>: <i>Miscellanous formatting helpers.</i>
<li> <b><a href="Pyblio.Format.OpenOffice-module.html"><code>OpenOffice</code></a></b>
<li> <b><a href="Pyblio.Format.Pages-module.html"><code>Pages</code></a></b>
<li> <b><a href="Pyblio.Format.Person-module.html"><code>Person</code></a></b>
<li> <b><a href="Pyblio.Format.S2-module.html"><code>S2</code></a></b>: <i>(Data structures for stage 2 of the formatter)</i>
<li> <b><a href="Pyblio.Format.S3-module.html"><code>S3</code></a></b>: <i>(Stage 3 objects, ie abstract representation of the actual layout)</i>
<li> <b><a href="Pyblio.Format.Text-module.html"><code>Text</code></a></b>: <i>Transformation of the formatted record into a textual
representation.</i>
</ul>
<li> <b><a href="Pyblio.I18n-module.html"><code>I18n</code></a></b>: <i>Useful tools related to internationalization issues.</i>
<li> <b><a href="Pyblio.Parsers-module.html"><code>Parsers</code></a></b>: <i>Bibliographic database parsers for foreign formats.</i>
<ul>
<li> <b><a href="Pyblio.Parsers.Protocol-module.html"><code>Protocol</code></a></b>: <i>Protocol definition for importing or exporting data from alien file
formats.</i>
<li> <b><a href="Pyblio.Parsers.Semantic-module.html"><code>Semantic</code></a></b>: <i>Parsers for bibliographic formats and specific schemas.</i>
<ul>
<li> <b><a href="Pyblio.Parsers.Semantic.BibTeX-module.html"><code>BibTeX</code></a></b>
<li> <b><a href="Pyblio.Parsers.Semantic.PubMed-module.html"><code>PubMed</code></a></b>: <i>Parser for the XML format returned by PubMed's Web API</i>
<li> <b><a href="Pyblio.Parsers.Semantic.WOK-module.html"><code>WOK</code></a></b>
</ul>
<li> <b><a href="Pyblio.Parsers.Syntax-module.html"><code>Syntax</code></a></b>: <i>Syntactic parsers for bibliographic formats.</i>
<ul>
<li> <b><a href="Pyblio.Parsers.Syntax.BibTeX-module.html"><code>BibTeX</code></a></b>: <i>Extension module for BibTeX files</i>
<ul>
<li> <b><a href="Pyblio.Parsers.Syntax.BibTeX.Coding-module.html"><code>Coding</code></a></b>: <i>Handles coding and decoding of LaTeX-escaped characters.</i>
<li> <b><a href="Pyblio.Parsers.Syntax.BibTeX.Environ-module.html"><code>Environ</code></a></b>: <i>Handles decoding of &#64;string substitution and of LaTeX
commands.</i>
<li> <b><a href="Pyblio.Parsers.Syntax.BibTeX.Parser-module.html"><code>Parser</code></a></b>: <i>Stream oriented reading of a BibTeX file, with no actual semantic
operation on the content.</i>
</ul>
<li> <b><a href="Pyblio.Parsers.Syntax.ISI-module.html"><code>ISI</code></a></b>
<li> <b><a href="Pyblio.Parsers.Syntax.RIS-module.html"><code>RIS</code></a></b>
<li> <b><a href="Pyblio.Parsers.Syntax.Tagged-module.html"><code>Tagged</code></a></b>
<li> <b><a href="Pyblio.Parsers.Syntax.XMLEndNote-module.html"><code>XMLEndNote</code></a></b>
<li> <b><a href="Pyblio.Parsers.Syntax.XMLMARC-module.html"><code>XMLMARC</code></a></b>
</ul>
</ul>
<li> <b><a href="Pyblio.Query-module.html"><code>Query</code></a></b>: <i>Definition of the query language.</i>
<li> <b><a href="Pyblio.Registry-module.html"><code>Registry</code></a></b>: <i>Support for RIP files.</i>
<li> <b><a href="Pyblio.Schema-module.html"><code>Schema</code></a></b>: <i>Schema definition for a pyblio database.</i>
<li> <b><a href="Pyblio.Sort-module.html"><code>Sort</code></a></b>: <i>Definition of the sort language.</i>
<li> <b><a href="Pyblio.Store-module.html"><code>Store</code></a></b>: <i>Contains the base classes and interfaces used to define a database of
records.</i>
<li> <b><a href="Pyblio.Stores-module.html"><code>Stores</code></a></b>: <i>Available physical stores.</i>
<ul>
<li> <b><a href="Pyblio.Stores.bsddbstore-module.html"><code>bsddbstore</code></a></b>: <i>Store implementation on top of Berkeley DB (&gt;= 4.1)</i>
<li> <b><a href="Pyblio.Stores.filestore-module.html"><code>filestore</code></a></b>: <i>Provides an in-memory store, which can read and save the database in
Pyblio's XML format.</i>
<li> <b><a href="Pyblio.Stores.memorystore-module.html"><code>memorystore</code></a></b>: <i>Provides an UNSAVED in-memory store.</i>
</ul>
<li> <b><a href="Pyblio.Tools-module.html"><code>Tools</code></a></b>
</ul></td></tr>
</table><br />
<!-- =========== START OF FUNCTION SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Function Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><code><a name="init_logging"></a><span class="summary-sig"><span class="summary-sig-name">init_logging</span>()</span></code>
</td></tr>
</table><br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th bgcolor="#70b0f0" class="navselect">&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>
<th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
pybliographer&nbsp;1.3.3
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Sep 24 23:52:43 2006</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>

Event Timeline