Metadata-Version: 2.1
Name: bibpy
Version: 1.0.0
Summary: Bib(la)tex parsing and useful tools
Home-page: https://bibpy.readthedocs.io/en/latest/
Author: Alexander Asp Bock
Author-email: albo.developer@gmail.com
License: BSD 3-Clause License
Project-URL: Issue Tracker, https://github.com/MisanthropicBit/bibpy/issues
Project-URL: Documentation, https://bibpy.readthedocs.io/en/latest/
Project-URL: Source, https://github.com/MisanthropicBit/bibpy
Description: # bibpy v1.0.0
        
        [![Build status](https://travis-ci.org/MisanthropicBit/bibpy.svg?branch=master)](https://travis-ci.org/github/MisanthropicBit/bibpy)
        [![Read the Docs](https://img.shields.io/readthedocs/bibpy)](https://readthedocs.org/projects/bibpy/)
        [![Coverage Status](https://coveralls.io/repos/github/MisanthropicBit/bibpy/badge.svg?branch=master)](https://coveralls.io/github/MisanthropicBit/bibpy?branch=master)
        [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/MisanthropicBit/bibpy/blob/master/LICENSE)
        [![PyPI](https://img.shields.io/pypi/v/bibpy)](https://pypi.org/project/bibpy/)
        [![PyPI wheel](https://img.shields.io/pypi/wheel/bibpy)](https://pypi.org/project/bibpy/)
        [![Python version](https://img.shields.io/pypi/pyversions/bibpy.svg)](https://pypi.org/project/bibpy/)
        
        Python library for parsing bib(la)tex files and manipulating entries.
        
        * [Automatic conversion](https://github.com/MisanthropicBit/bibpy/tree/master/examples/field_conversion.py) of entry fields to and from appropriate Python types
        * [Requirements-checking for entry fields](https://github.com/MisanthropicBit/bibpy/tree/master/examples/requirements_check.py)
        * [String variable expansion and unexpansion](https://github.com/MisanthropicBit/bibpy/tree/master/examples/string_expansion.py)
        * [Crossreference and xdata inheritance](https://github.com/MisanthropicBit/bibpy/tree/master/examples/crossref_expansion.py)
        * Accompanying [tools](https://bibpy.readthedocs.io/en/latest/tutorial.html#bibpy-tools)
        
        # Installation
        
        ```bash
        pip install bibpy
        ```
        
        <a name="quickstart"></a>
        # Quickstart
        
        ```python
        >>> import bibpy
        >>> result = bibpy.read_file('references.bib')  # Read a bib file
        >>> entries = result.entries
        >>> print len(entries)
        6
        >>> print entries[0].author
        'D. J. Power'
        >>> print entries[0].bibkey
        '2006_power'
        >>> print entries[0].bibtype
        'online'
        >>> print entries[0].valid('bibtex')
        True  # Entry is a valid bibtex entry
        >>> print entries[0].valid('biblatex')
        False  # But is not a valid biblatex entry (missing field 'date' or 'year')
        >>> print entries[0].aliases('bibtex')
        []
        >>> print entries[0].aliases('biblatex')
        ['electronic', 'www']
        >>> bibpy.write_file('references.bib', entries)
        ```
        
        See the [`examples`](https://github.com/MisanthropicBit/bibpy/tree/master/examples)
        folder for more usage examples or read the
        [tutorial](https://bibpy.readthedocs.io/en/latest/tutorial.html).
        
        ## Tools
        
        `bibpy` also comes with three tools that are installed as runnable scripts.
        
        * `bibformat`: Clean up, format and align references
        * `bibgrep`  : Find and filter references using a simple query language
        * `bibstats` : Display statistics about bib files
        
        All three tools are described in more detail in the
        [tutorial](https://bibpy.readthedocs.io/en/latest/tutorial.html#bibpy-tools).
        
Keywords: bibpy,bibtex,biblatex,parser
Platform: All
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Utilities
Classifier: Topic :: Software Development
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.5
Description-Content-Type: text/markdown
