<!--
This file is part of pybib2web, a translator of BibTeX to HTML.
https://gitlab.com/sosy-lab/software/pybib2web
SPDX-FileCopyrightText: 2021 Dirk Beyer <https://www.sosy-lab.org>
SPDX-License-Identifier: Apache-2.0
-->
# pybib2web
Convert BibTeX .bib files into a directory of HTML files.
The created HTML provide individual HTML pages for publications by
year, publication type (category), author, keyword, and funding.
A single-page view is also available.
pybib2web provides semantics and easy customizability of each BibTeX element
through HTML ids and classes.
This makes it easy to choose the data to display and style the bibliography to your needs.
Send us a message or create an issue if you require any assistance and/or have feedback!
## Examples
You can find a raw example in [doc/example/index.html](doc/example/index.html).
This example is generated with:
```
pybib2web --config doc/example/config.yml --output doc/example doc/example/db.bib
```
Two pages that use pybib2web with styling:
- [Webpage of the Software and Computational Systems Lab (SoSy-Lab) at LMU Munich](https://www.sosy-lab.org/research/bib/All/index.html) uses full pybib2web directory structure with individual pages for author, keywords, etc..
- [Personal webpage of Thomas Lemberger](https://thomaslemberger.com/publications.html) uses `--singlepage` to display a single page with all entries.
## Requirements
- python 3.8
### Optional requirements
`detex` is required to detexify BibTeX-entries that use LaTeX commands,
e.g., `\sc{}` or `~`. If `detex` is not installed, these LaTeX commands will be visible
in the HTML output.
## Installation
After cloning the repository, run `pip install -e .` to install pybib2web and its dependencies.
## Usage
Run `pybib2web --help` to show all available command-line options.
Basic usage:
```
pybib2web BIBFILE(s)
```
This will write a directory of HTML files to `bib/`.
The index of these files is `bib/index.html`.
This will, among other things, create
an individual publication page for all authors that appear in the given BibTeX files.
Often, one only wants to create these author-centered pages for individual authors-
for example for oneself or a specific group of people.
pybib2web can be configured through a [config file](doc/config.yml) to do this:
```
pybib2web --config CONFIG_YAML BIBFILE(s)
```
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/sosy-lab/software/pybib2web",
"name": "pybib2web",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "bibliography,BibTeX",
"author": "Dirk Beyer",
"author_email": "dirk.beyer@sosy-lab.org",
"download_url": "https://files.pythonhosted.org/packages/2d/bb/74b317e516c8281c9c0eefdfbb4cfc1dbd08359cefce0ddaf181de85ee68/pybib2web-0.5.1.tar.gz",
"platform": null,
"description": "<!--\nThis file is part of pybib2web, a translator of BibTeX to HTML.\nhttps://gitlab.com/sosy-lab/software/pybib2web\n\nSPDX-FileCopyrightText: 2021 Dirk Beyer <https://www.sosy-lab.org>\n\nSPDX-License-Identifier: Apache-2.0\n-->\n\n# pybib2web\n\nConvert BibTeX .bib files into a directory of HTML files.\n\nThe created HTML provide individual HTML pages for publications by\nyear, publication type (category), author, keyword, and funding.\nA single-page view is also available.\npybib2web provides semantics and easy customizability of each BibTeX element\nthrough HTML ids and classes.\n\nThis makes it easy to choose the data to display and style the bibliography to your needs.\n\nSend us a message or create an issue if you require any assistance and/or have feedback!\n\n## Examples\n\nYou can find a raw example in [doc/example/index.html](doc/example/index.html).\nThis example is generated with:\n\n```\npybib2web --config doc/example/config.yml --output doc/example doc/example/db.bib\n```\n\nTwo pages that use pybib2web with styling:\n\n- [Webpage of the Software and Computational Systems Lab (SoSy-Lab) at LMU Munich](https://www.sosy-lab.org/research/bib/All/index.html) uses full pybib2web directory structure with individual pages for author, keywords, etc..\n- [Personal webpage of Thomas Lemberger](https://thomaslemberger.com/publications.html) uses `--singlepage` to display a single page with all entries.\n\n\n## Requirements\n\n- python 3.8\n\n### Optional requirements\n\n`detex` is required to detexify BibTeX-entries that use LaTeX commands,\ne.g., `\\sc{}` or `~`. If `detex` is not installed, these LaTeX commands will be visible\nin the HTML output.\n\n\n## Installation\n\nAfter cloning the repository, run `pip install -e .` to install pybib2web and its dependencies.\n\n\n## Usage\n\nRun `pybib2web --help` to show all available command-line options.\n\nBasic usage:\n\n```\npybib2web BIBFILE(s)\n```\n\nThis will write a directory of HTML files to `bib/`.\nThe index of these files is `bib/index.html`.\n\nThis will, among other things, create\nan individual publication page for all authors that appear in the given BibTeX files.\nOften, one only wants to create these author-centered pages for individual authors-\nfor example for oneself or a specific group of people.\npybib2web can be configured through a [config file](doc/config.yml) to do this:\n\n```\npybib2web --config CONFIG_YAML BIBFILE(s)\n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A translator of BibTeX to HTML.",
"version": "0.5.1",
"project_urls": {
"Changelog": "https://gitlab.com/sosy-lab/software/pybib2web/-/blob/main/CHANGELOG.md",
"Homepage": "https://gitlab.com/sosy-lab/software/pybib2web",
"Issue Tracker": "https://gitlab.com/sosy-lab/software/pybib2web/-/issues"
},
"split_keywords": [
"bibliography",
"bibtex"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3639d281b687ad00afa662f2120b0c630e5394ed7162dad1aff954c7be95f25c",
"md5": "5a466aec28fbc8cbd4df2cd4dd827eb7",
"sha256": "217c17faae738ee9c34fbb659108e41f7342cf64e46f56c8df9b5ab6c3ceb0e7"
},
"downloads": -1,
"filename": "pybib2web-0.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5a466aec28fbc8cbd4df2cd4dd827eb7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 21647,
"upload_time": "2023-07-03T15:01:42",
"upload_time_iso_8601": "2023-07-03T15:01:42.867838Z",
"url": "https://files.pythonhosted.org/packages/36/39/d281b687ad00afa662f2120b0c630e5394ed7162dad1aff954c7be95f25c/pybib2web-0.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2dbb74b317e516c8281c9c0eefdfbb4cfc1dbd08359cefce0ddaf181de85ee68",
"md5": "d69a82f3d7efa172a297b67c272ae383",
"sha256": "f337b4eb8c1a87cc6d4902fe170fc111e58d41f146c74ea077487ba5de5ae35d"
},
"downloads": -1,
"filename": "pybib2web-0.5.1.tar.gz",
"has_sig": false,
"md5_digest": "d69a82f3d7efa172a297b67c272ae383",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 21026,
"upload_time": "2023-07-03T15:01:45",
"upload_time_iso_8601": "2023-07-03T15:01:45.067591Z",
"url": "https://files.pythonhosted.org/packages/2d/bb/74b317e516c8281c9c0eefdfbb4cfc1dbd08359cefce0ddaf181de85ee68/pybib2web-0.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-03 15:01:45",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "sosy-lab",
"gitlab_project": "software",
"lcname": "pybib2web"
}
JSON