Getting Started¶

import six
import pybtex.database.input.bibtex
import pybtex.plugin

style = pybtex.plugin.find_plugin('pybtex.style.formatting', 'plain')()
backend = pybtex.plugin.find_plugin('pybtex.backends', 'docutils')()
parser = pybtex.database.input.bibtex.Parser()
data = parser.parse_stream(six.StringIO(u"""
@Book{1985:lindley,
  author =    {D. Lindley},
  title =     {Making Decisions},
  publisher = {Wiley},
  year =      {1985},
  edition =   {2nd},
}
"""))
for entry in style.format_entries(six.itervalues(data.entries)):
    print(backend.paragraph(entry))

<paragraph>
  D. Lindley. <emphasis>Making Decisions</emphasis>.
  Wiley, 2nd edition, 1985.
</paragraph>

API¶

The backend renders pybtex.richtext.Text instances into a list of docutils.nodes.Text and docutils.nodes.inline instances (or subclasses of these). For typical use cases, all you need to care about are the methods Backend.paragraph(), Backend.citation(), and Backend.citation_reference() which are to be called on formatted entries, as in the minimal example.

Note that you should not import the pybtex_docutils module directly. Instead, use pybtex’s plugin system to get the Backend class, again, as in the minimal example.

class pybtex_docutils.Backend(encoding=None)¶

Bases: pybtex.backends.BaseBackend

RenderType¶

alias of list

citation(entry, document, use_key_as_label=True)¶

Return citation node, with key as name, label as first child, and paragraph with entry text as second child. The citation is expected to be inserted into document prior to any docutils transforms.

citation_reference(entry, document, use_key_as_label=True)¶

Return citation_reference node to the given citation. The citation_reference is expected to be inserted into document prior to any docutils transforms.

paragraph(entry)¶

Return a docutils.nodes.paragraph containing the rendered text for entry (without label).

New in version 0.2.0.

Changes¶

License¶

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.