This utility extracts Bib(La)Tex references (a.k.a *markers*) from a (La)Tex.
Project description
BibTex Extract and Populate
This utility extracts BibTex references (a.k.a markers) from a (La)Tex file and copies entries from a source, which the master BibTex file. The use case is exporting all BetterBibtex entries to a file on your file system, usually one that is updated as you add, remove and modify papers in Zotero.
Note: While the use case was intended for use with Zoter and BetterBibtex, it will work on any BibTex file.
The program does the following:
- Parses some large master source BibTex file.
- Parses a file or recursively all
.tex
,.sty
, and.cls
files recursively in a directory. - Copies the matching entries from the master source BibTex to standard out.
The program makes the assumption that the BibTex entry IDs are unique as the matches are very loose when parsing the (La)Tex file.
Obtaining
The easiest way to install the command line program is via the pip
installer:
pip3 install zensols.bibstract
Binaries are also available on pypi.
Usage
This is a command line program written that has the following usage (also use
--help
):
- Print IDs in a master source file BibTex file:
bibstract showbib
. - Print cite references in a (La)Tex file:
bibstract showtex <file|directory>
- Print IDs that will be exported from the BibTex file:
bibstract showexport <file|directory>
- Export the matching entries to standard out:
bibstract export <file|directory>
Configuration
A configuration file must be given, whose location is either given with a
-c
command line argument, or set in the environment variable BIBSTRACTRC
.
An example configuration file is available, which has only one INI section
default
with option master_bib
with the master BibTex file.
Converters
A set of converters can be specified in the configuration file, which modify each parsed BibTex entry in succession. Currently there the following:
date_year
Converts the year part of a date field to a year. This is useful when using Zotero's Better Biblatex extension that produces BibLatex formats, but you need BibTex entries.
copy
Copy or move one or more fields in the entry. This is useful when your
bibliography style expects one key, but the output (i.e.BibLatex) outputs a
different named field). When destructive
is set to True
, this copy
operation becomes a move.
Changelog
An extensive changelog is available here.
License
Copyright (c) 2020 - 2021 Paul Landes
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distributions
Hashes for zensols.bibstract-0.0.4-py3.9.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | ffe5c1ec4fc84fa280285e1ca537bf21ef7824c7c79b155cd059eaef450e6ccb |
|
MD5 | facf77dcff280a96ea0542abedb13b22 |
|
BLAKE2b-256 | ef1337ee54aef2e738d1a7bde936ed83374f3b76b2ee7457059d4b90f908284e |
Hashes for zensols.bibstract-0.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6b3dbab4445c25e04c99397514edb8995d5e8a0651e97d4b32ff4c41b963c24a |
|
MD5 | c7c6347386f2e3655fc1ef9642e11487 |
|
BLAKE2b-256 | f241894d2a3721f9bd9d95e84a9c1ce350e02b6ded46cce5688b4c85e6ba7293 |