Metadata-Version: 2.1
Name: bibtex2html.py
Version: 2.1.0
Summary: Convert bibtex to html.
Home-page: https://github.com/JianCheng/bibtex2html.py
Author: Jian Cheng
Author-email: jian.cheng.1983@gmail.com
License: BSD
Platform: UNKNOWN
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Dist: bs4
Requires-Dist: bibtexparser
Requires-Dist: docopt


# bibtex2html.py

[bibtex2html.py](https://github.com/JianCheng/bibtex2html.py) coverts a bibtex file into an html file or a group of html files.
It considers additional fields (e.g., note, code, etc.) in bibtex. 
It also can show corresponding google scholar citations related with bibtex entries by parsing the google scholar profile. 


## Dependancies

Dependencies can be satisfied by running `pip install -r requirements.txt`


## Install 

* Use `pip`:

```
sudo pip install bibtex2html.py
```

* Or download latest codes from github

```
git clone https://github.com/JianCheng/bibtex2html.py
cd  bibtex2html.py
pip install -r requirements.txt
```


## Examples

#### To generate an html file 

* Generate paper lists by type and by year using a configuration file. It requires access to google scholar.

```
cd examples
bibtex2html.py papers.bib papers.html -c papers.ini 
```

* Do not show paper citations if you cannot access google scholar. Override options in configuration file.

```
bibtex2html.py papers.bib papers.html -c papers.ini --nc
```
Or

```
bibtex2html.py papers.bib papers.html -c papers.ini -i "{'show_citation':'no', 'show_total_citation':False}"
```


* Generate paper list by type with a selected first author and selected years.

```
bibtex2html.py papers.bib papers.html -c papers.ini -i "{'show_paper_style':'type', 'selection_and': {'author_first': ['Jian Cheng'], 'year':[2010,2013] }}"
```

#### To generate a group of html files

* Use `author_group` option to specify a group of people, then generate html files for the group.

```
cd examples
bibtex2html.py papers_group.bib papers -c papers_group.ini 
```
It outputs files in the folder `papers`.

* Do not show paper citations if you cannot access google scholar. Override options in configuration file.

```
bibtex2html.py papers_group.bib papers -c papers_group.ini --nc
```


