Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 3 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.2%) to scientific vocabulary
Keywords
bibliography
bibtex
cite
literature
references
Last synced: 6 months ago
·
JSON representation
·
Repository
Handling bibliographic records within source code
Basic Info
- Host: GitHub
- Owner: tillbiskup
- License: bsd-2-clause
- Language: Python
- Default Branch: master
- Homepage: https://bibrecord.docs.till-biskup.de/
- Size: 80.1 KB
Statistics
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
- Releases: 5
Topics
bibliography
bibtex
cite
literature
references
Created over 4 years ago
· Last pushed almost 2 years ago
Metadata Files
Readme
Contributing
License
Citation
Roadmap
README.rst
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.10607369.svg
:target: https://doi.org/10.5281/zenodo.10607369
:align: right
=========
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:
.. code-block::
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:
.. code-block::
reference.to_string()
The result:
J. 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:
.. code-block:: bash
pip install bibrecord
License
=======
This program is free software: you can redistribute it and/or modify it under the terms of the **BSD License**.
Owner
- Login: tillbiskup
- Kind: user
- Location: Germany
- Website: https://www.till-biskup.de/
- Repositories: 14
- Profile: https://github.com/tillbiskup
Scientist focussing on reproducible research, particularly in spectroscopy
Citation (CITATION.cff)
cff-version: 1.2.0
message: If you use this software, please cite it using these metadata.
title: bibrecord
abstract: >
Handling bibliographic records within (Python) 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.
authors:
- family-names: Biskup
given-names: Till
orcid: "https://orcid.org/0000-0003-2913-0004"
type: software
license: BSD-2-Clause
repository-code: "https://github.com/tillbiskup/bibrecord"
keywords:
- "bibliography"
- "bibtex"
- "literature"
- "cite"
- "references"
identifiers:
- description: "The concept DOI of the work."
type: doi
value: 10.5281/zenodo.10607369
GitHub Events
Total
Last Year
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 0
- Total pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Total issue authors: 0
- Total pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 95 last-month
- Total dependent packages: 2
- Total dependent repositories: 1
- Total versions: 4
- Total maintainers: 1
pypi.org: bibrecord
Handling bibliographic records within source code
- Documentation: https://bibrecord.docs.till-biskup.de/
- License: BSD
-
Latest release: 0.2.2
published almost 2 years ago
Rankings
Dependent packages count: 4.7%
Dependent repos count: 21.6%
Average: 23.9%
Downloads: 24.7%
Forks count: 29.8%
Stargazers count: 38.8%
Maintainers (1)
Last synced:
6 months ago
Dependencies
setup.py
pypi