Implement support for "BibTeX" file cleanup.

Author: KelSolaar

BIBLIOGRAPHY.bib

@@ -1,7 +1,7 @@
 @misc{Abecassis2011,
-author = {Abecassis, Felix},
-title = {{OpenCV - Rotation (Deskewing)}},
-url = {http://felix.abecassis.me/2011/10/opencv-rotation-deskewing/},
-urldate = {2018-10-27},
-year = {2011}
+  author       = {Abecassis, Felix},
+  title        = {{OpenCV - Rotation (Deskewing)}},
+  url          = {http://felix.abecassis.me/2011/10/opencv-rotation-deskewing/},
+  urldate      = {2018-10-27},
+  year         = 2011,
 }

setup.py

@@ -9,7 +9,7 @@
 
 import os
 import re
-
+import sys
 from setuptools import setup
 from setuptools import find_packages
 
@@ -45,6 +45,11 @@
 DEVELOPMENT_REQUIREMENTS = DOCS_REQUIREMENTS + TESTS_REQUIREMENTS + [
     'invoke', 'restructuredtext_lint', 'twine', 'yapf'
 ]
+if sys.version_info[:2] >= (3, 2):
+    DEVELOPMENT_REQUIREMENTS += [
+        'biblib @ git+ssh://git@github.comcolour-science/biblib'
+        '@v0.1.0#egg=biblib'
+    ]
 
 
 def get_version():

tasks.py

@@ -6,6 +6,9 @@
 
 from __future__ import unicode_literals
 
+import sys
+if sys.version_info[:2] >= (3, 2):
+    import biblib.bib
 import fnmatch
 import os
 import re
@@ -22,9 +25,10 @@
 __status__ = 'Production'
 
 __all__ = [
-    'APPLICATION_NAME', 'PYTHON_PACKAGE_NAME', 'PYPI_PACKAGE_NAME', 'clean',
-    'formatting', 'tests', 'quality', 'examples', 'docs', 'todo', 'preflight',
-    'build', 'virtualise', 'tag', 'release', 'sha256'
+    'APPLICATION_NAME', 'PYTHON_PACKAGE_NAME', 'PYPI_PACKAGE_NAME',
+    'BIBLIOGRAPHY_NAME', 'clean', 'formatting', 'tests', 'quality', 'examples',
+    'docs', 'todo', 'preflight', 'build', 'virtualise', 'tag', 'release',
+    'sha256'
 ]
 
 APPLICATION_NAME = colour_checker_detection.__application_name__
@@ -33,6 +37,8 @@
 
 PYPI_PACKAGE_NAME = 'colour-checker-detection'
 
+BIBLIOGRAPHY_NAME = 'BIBLIOGRAPHY.bib'
+
 
 @task
 def clean(ctx, docs=True, bytecode=False):
@@ -69,7 +75,7 @@ def clean(ctx, docs=True, bytecode=False):
 
 
 @task
-def formatting(ctx, yapf=False, asciify=True):
+def formatting(ctx, yapf=False, asciify=True, bibtex=True):
     """
     Formats the codebase with *Yapf* and converts unicode characters to ASCII.
 
@@ -81,6 +87,8 @@ def formatting(ctx, yapf=False, asciify=True):
         Whether to format the codebase with *Yapf*.
     asciify : bool, optional
         Whether to convert unicode characters to ASCII.
+    bibtex : bool, optional
+        Whether to cleanup the *BibTeX* file.
 
     Returns
     -------
@@ -97,6 +105,26 @@ def formatting(ctx, yapf=False, asciify=True):
         with ctx.cd('utilities'):
             ctx.run('./unicode_to_ascii.py')
 
+    if bibtex and sys.version_info[:2] >= (3, 2):
+        message_box('Cleaning up "BibTeX" file...')
+        bibtex_path = BIBLIOGRAPHY_NAME
+        with open(bibtex_path) as bibtex_file:
+            bibtex = biblib.bib.Parser().parse(
+                bibtex_file.read()).get_entries()
+
+        for entry in sorted(bibtex.values(), key=lambda x: x.key):
+            try:
+                del entry['file']
+            except KeyError:
+                pass
+            for key, value in entry.items():
+                entry[key] = re.sub('(?<!\\\\)\\&', '\\&', value)
+
+        with open(bibtex_path, 'w') as bibtex_file:
+            for entry in bibtex.values():
+                bibtex_file.write(entry.to_bib())
+                bibtex_file.write('\n')
+
 
 @task
 def tests(ctx, nose=True):