Skip to main content
https://zenodo.org/badge/DOI/10.5281/zenodo.10607369.svg

bibrecord

Handling bibliographic records within source code.

Did you ever feel the need of adding a reference to the literature to your code, e.g. to an article describing the algorithm you just (re)implemented? Are you somewhat familiar with how bibliographic records look like, e.g. from using BibTeX in conjunction with the TeX/LaTeX typesetting system? Then bibrecord may be the tool of choice for you.

Suppose you have implemented power-law noise and want to refer to the literature to give credit to those guys whose algorithm you’ve implemented. In this case, you could add the following record as an attribute to your class:

reference = bibrecord.Article(
    author=['J. Timmer', 'M. König'],
    title="On generating power law noise",
    journal="Astronomy and Astrophysics",
    volume="300",
    pages="707--710",
    year="1995"
)

If you would like to output the reference as plain text, this would be as simple as:

reference.to_string()

The result:

  1. Timmer, M. König: On generating power law noise. Astronomy and Astrophysics 300:707–710, 1995.

Features

A list of features:

  • Support for (a growing list of) different types of bibliographic records (articles, books).

  • Straight-forward definition of bibliographic records, similar to BibTeX.

  • Easy integration of a bibliographic record into your existing code base.

  • Simple, yet powerful ways of creating a string representation or a BibTeX record from each bibliographic record.

And to make it even more convenient for users and future-proof:

  • Open source project written in Python (>= 3.7)

  • Developed fully test-driven

  • Extensive user and API documentation

Installation

To install the bibrecord package on your computer (sensibly within a Python virtual environment), open a terminal (activate your virtual environment), and type in the following:

pip install bibrecord

License

This program is free software: you can redistribute it and/or modify it under the terms of the BSD License.

Metadata

Release files for bibrecord 0.2.2

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

Source distribution (sdist)

Source distribution for bibrecord 0.2.2
File Size Uploaded
bibrecord-0.2.2.tar.gz 18.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for bibrecord 0.2.2
File Interpreter ABI Platform
bibrecord-0.2.2-py3-none-any.whl Python 3 none any Details

Total release size: 33.8 kB

Release files / bibrecord-0.2.2.tar.gz

Download URL bibrecord-0.2.2.tar.gz
Size 18.5 kB
Tags Source
SHA-256 checksum
How to use checksums
8a0ad4ef5f9b573e02551835e80405d2b34a0e4d4b4aa352a3b838f3a7aec053
BLAKE2b-256 checksum
How to use checksums
faf47d3f968207eb2c9a1f7e84b10f06433330c11f713f79beb34ce4aa6c616f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.9.2

Release files / bibrecord-0.2.2-py3-none-any.whl

Download URL bibrecord-0.2.2-py3-none-any.whl
Size 15.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b7d583e5d7baa1cc6180f43db4475a131782b8b55b72d7205994b1161e2f1509
BLAKE2b-256 checksum
How to use checksums
06a7f91455d9b32d0200ec7b867ae1de7c7a646db349b8815e1a496459061c00
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.9.2

Release history Release notifications | RSS feed

This release

0.2.2 This release

2 release files

0.2.1

2 release files

0.2.0

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