Skip to main content

Pelican BibTeX Reader: A Plugin for Pelican

PyPI Version License

A Pelican reader to process BibTeX files

Installation

This plugin can be installed via:

python -m pip install pelican-bibtex-reader

Usage

This plugin uses python-bibtexparser to parse properly formatted BibTeX files for use in Pelican. Just put a BibTeX file with ending .bib anywhere in your content directory.

The content provided by this plugin consists of only a crude HTML rendering of the key-value pairs of each entry. However, the full bibtex database is available as Python object in the metadata of the page (key: bibtexdatabase). Using an appropriate template, nice lists of literature can be rendered, easily. Check out the literature list on my homepage for an example.

Metadata needed for Pelican (such as the title, the date, or the template to be used) can be added at the top of the .bib-file, using the following syntax:

% Title: Some title
% Date: 01.02.2023
% ...
% Feel free to write anything else; only
% key: value
% pairs are parsed. All other comments are ignored.

@MISC{...}

Contributing

Contributions are welcome and much appreciated. Every little bit helps. You can contribute by improving the documentation, adding missing features, and fixing bugs. You can also help out by reviewing and commenting on existing issues.

To start contributing to this plugin, review the Contributing to Pelican documentation, beginning with the Contributing Code section.

License

This project is licensed under the AGPL-3.0 license.

Release files for pelican-bibtex-reader 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pelican-bibtex-reader 0.1.1
File Size Uploaded
pelican_bibtex_reader-0.1.1.tar.gz 15.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pelican-bibtex-reader 0.1.1
File Interpreter ABI Platform
pelican_bibtex_reader-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 32.5 kB

Release files / pelican_bibtex_reader-0.1.1.tar.gz

Download URL pelican_bibtex_reader-0.1.1.tar.gz
Size 15.8 kB
Tags Source
SHA-256 checksum
How to use checksums
ecb749eaab16c74b8f1ebf70f8935e7b9a04562a106994fce96cf985c043e041
BLAKE2b-256 checksum
How to use checksums
167edb17741715ea4c8b4c748c396e01d207e545c8202ae312a0fc833f3b1373
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.5.1 CPython/3.11.3 Linux/6.3.9-arch1-1

Release files / pelican_bibtex_reader-0.1.1-py3-none-any.whl

Download URL pelican_bibtex_reader-0.1.1-py3-none-any.whl
Size 16.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
56382841a831181b7bb5ed17dc5f5c07e66361600eb12e96bd9b04a4983f6639
BLAKE2b-256 checksum
How to use checksums
b5fa8d9f76ea6df30217c79cfa2b1ae69345a2680d9ddf53f36dbf59d8ba914d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.5.1 CPython/3.11.3 Linux/6.3.9-arch1-1

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page