Metadata-Version: 1.2
Name: bib_cleaner
Version: 0.3.2
Summary: Bib Cleaner removes unnecessary entries from your bib files.
Home-page: https://github.com/sriki18/bib_cleaner
Author: Srikiran Chandrasekaran
Author-email: srikiranc@gmail.com
License: BSD license
Description: ===========
        Bib Cleaner
        ===========
        
        
        .. image:: https://img.shields.io/pypi/v/bib_cleaner.svg
                :target: https://pypi.python.org/pypi/bib_cleaner
        
        .. image:: https://img.shields.io/travis/sriki18/bib_cleaner.svg
                :target: https://travis-ci.org/sriki18/bib_cleaner
        
        .. image:: https://readthedocs.org/projects/bib-cleaner/badge/?version=latest
                :target: https://bib-cleaner.readthedocs.io/en/latest/?badge=latest
                :alt: Documentation Status
        
        .. image:: https://img.shields.io/badge/license-BSD-brightgreen.svg
                :target: https://img.shields.io/badge/license-BSD-brightgreen
        
        
        Bib Cleaner removes unnecessary entries from your bib files. Documentation @ https://bib-cleaner.readthedocs.io.
        
        Use case
        --------
        
        1. You have been writing a TeX document for a while, and adding citation entries to your ``.bib`` file (say it's called ``master.bib``).
        2. In the course of writing, some entries in your ``master.bib`` have become obsolete. You don't use them in your TeX document anymore.
        3. Of course, LaTeX compiles quite happily with these extra entries.
        4. You take a step back, sip some coffee, go for a walk, all the while pondering "Man, I wish I could just `remove` those extra bib entries". You yearn for a world where all ``.bib`` files everywhere carry only what they have to, and no more.
        
        I gotchu. Enter ``bib_cleaner``.
        
        
        Installation
        ------------
        This should work::
        
            $ pip install bib_cleaner
        
        Verify if it installed by typing the following in the command-line::
        
            $ bib_cleaner -h
        
        You should see the help::
        
            usage: bib_cleaner [-h] [-t TEXFILES [TEXFILES ...]] [-o OUTPUTBIB] masterfile
        
            Produce a minimal bib file with only the entries found in your .tex file(s)
        
            positional arguments:
            masterfile            master bib file with used and unused citations (.bib)
        
            optional arguments:
            -h, --help            show this help message and exit
            -t TEXFILES [TEXFILES ...], --texfiles TEXFILES [TEXFILES ...]
                                    content files to select entries from (.tex)
            -o OUTPUTBIB, --outputbib OUTPUTBIB
                                    output file name with extension
        
        Examples
        --------
        After installation, navigate to your TeX directory try::
        
            $ bib_cleaner master.bib
        
        Of course, replace ``master.bib`` with the name of your bib file with obsolete bib entries. ``bib_cleaner`` will automatically detect all the TeX files (``.tex``) in that directory and use them to determine which bib entries are obsolete.
        
        Specify TeX files
        ~~~~~~~~~~~~~~~~~
        
        If you only want to use some TeX files, specify them with::
        
            $ bib_cleaner master.bib --texfiles chapter1.tex chapter2.tex
        
        or::
        
            $ bib_cleaner master.bib -t chapter1.tex chapter2.tex
        
        Specify output file name
        ~~~~~~~~~~~~~~~~~~~~~~~~
        
        If you want to change the output bib file name from the default ``new.bib``, do::
        
            $ bib_cleaner master.bib -t chapter1.tex --outputbib chapter1.bib
        
        or::
        
            $ bib_cleaner master.bib -t chapter1.tex -o chapter1.bib
        
        TODO
        ----
        
        * Remove typically unused lines from ``.bib`` files (like ``file = {...}`` or ``abstract = {...}``)
        * Detect and remove bib entries with identical tags / raise conflict
        * Add tests for the command-line interface
        
        Credits
        -------
        
        This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
        
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
        
        
        =======
        History
        =======
        
        0.3.0 (2019-12-20)
        ------------------
        
        Added
        ~~~~~
        * Option to store output in ``new.bib``
        * Intro and examples to ``README.rst``
        
        0.2.1 (2019-12-20)
        ------------------
        
        Added
        ~~~~~
        * ``get_minimal_bibs`` function.
        * tests for ``tex_to_tags`` and ``get_minimal_bibs``.
        
        Fixed
        ~~~~~
        * Documentation builds.
        * Deploy from Travis.
        
        Removed
        ~~~~~~~
        * Support for ``Python 3.5`` (no f-string support)
        
        0.1.0 (2019-12-16)
        ------------------
        
        * First release on PyPI.
        
Keywords: bib_cleaner
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
