|Phyks (Lucas Verney) 9ef1a29d25 Close issue #1||3 years ago|
|docs||3 years ago|
|libbmc||3 years ago|
|.gitignore||3 years ago|
|.gitmodules||3 years ago|
|LICENSE||3 years ago|
|MANIFEST.in||3 years ago|
|README.md||3 years ago|
|requirements.txt||3 years ago|
|setup.py||3 years ago|
A generic Python library to manage bibliography and play with scientific papers.
Note: This library is written for Python 3 and may not work with Python 2. This is not a major priority for me, but if anyone needed to make it work with Python 2 and want to make a PR, I will happily merge it :)
Python dependencies are listed in the
requirements.txt file at the root of
this repo, and can be installed with
pip install -r requirements.txt.
External dependencies are OpenDeTeX
(an improved version of DeTeX) and the
OpenDeTeX is available as a Git submodule in the
libbmc/external folder. If
you do not have it installed system-wide, you can use the following steps to
build it in this repo and the library will use it:
git submodule init; git submodule updateto initialize the Git submodules.
cd libbmc/external/opendetex; maketo build OpenDeTeX (see
INSTALLfile in the same folder for more info, you will need
flexto build it).
OpenDeTeX is used to get references from a
.bbl file (or directly from arXiv
as it uses the same pipeline).
djvutxt should be available in the packages of your
distribution and should be installed systemwide. Both are used to extract
identifiers from papers PDF files.
If you plan on using the
libbmc.citations.pdf functions, you should also
install the matching software (
pdf-extract). See the
docstrings of those functions for more infos on this particular point.
pip install libbmc or download the ZIP archive from this repo and
install it manually using
python setup.py install.
at the root of the Git repository to run the unittests.
cd docs make html
Documentation will be generated in the
libbmc exposes a
__valid_identifiers__ list, containing the valid
identifier types. These are those exposing the same function as
isbn modules, in particular the extraction from a string and BibTeX
If you write additional modules for others repositories, you can include them
__valid_identifiers__ list, as long as they provide these functions.
This list is especially useful for the
which is using it to loop through all the available identifier types, to fetch
for them in the paper and retrieve BibTeX from it.
You can also write a specific citation extraction module for this repository
This code is licensed under an MIT license.
Thanks a lot to the following authors and programs for helping in building this lib:
Dominika Tkaczyk, Pawel Szostek, Mateusz Fedoryszak, Piotr Jan Dendek and Lukasz Bolikowski. CERMINE: automatic extraction of structured metadata from scientific literature. In International Journal on Document Analysis and Recognition (IJDAR), 2015, vol. 18, no. 4, pp. 317-335, doi: 10.1007/s10032-015-0249-8. https://github.com/CeON/CERMINE