vitae 1.1.4__tar.gz

vitae-1.1.4/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2019, Joseph C. Slater
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

vitae-1.1.4/PKG-INFO

@@ -0,0 +1,198 @@
+Metadata-Version: 2.1
+Name: vitae
+Version: 1.1.4
+Summary: Tools for academics for building a Curriculum Vitae and other oft-requested documents.
+Home-page: https://github.com/josephcslater/vitae
+Author: Joseph C. Slater
+Author-email: joseph.c.slater@gmail.com
+License: UNKNOWN
+Keywords: curriculum vitae,academia,cv,resume
+Platform: UNKNOWN
+License-File: LICENSE
+
+
+.. image:: http://pepy.tech/badge/vitae
+   :target: http://pepy.tech/project/vitae
+   :alt: PyPi Download stats
+
+vitae
+=====
+
+A Python module for building curriculum vitae and other documents from a ``BibTeX`` file. ``vitae`` leverages bibtexparser_, `LaTeX`_, and pandoc_ to streamline getting citations of your papers into the formats you need quickly without manual intervention. Of course, with many settings, it can be a bit tedious. I personally recommend setting up a Jupyter_ notebook with the commands you regularly execute available there. Alternatively, you can call it from the terminal which allows it to work inside a more complex workflow.
+
+Purpose
+-------
+
+I hate formatting citations. It's tedious, and error-prone. Further, when I build my CV, I tend to muck it up and leave something out, mis-sort it, duplicate it accidentally, etc. So, I need a tool to do a better job with what is a menial task.
+
+Install
+-------
+
+.. code::
+
+  pip install vitae
+
+or
+
+.. code::
+
+   pip install --user vitae
+
+Usage
+-----
+
+Please see the brief `demo Jupyter notebook`_. It's very brief. I need to add more. The whole package is basically two functions. Please read the help:
+
+``makemycv``
+~~~~~~~~~~~~
+
+To do anything useful here, you must have `LaTeX`_ with BibTeX installed. If you don't use `LaTeX`_, this module isn't the place to start. Sorry.
+
+The first function here, ``makemycv``, will take a few arguments and put sorted ``\bibentry`` commands into ``.tex`` files with names corresponding to `BibTeX entry <https://en.wikibooks.org/wiki/LaTeX/Bibliography_Management#BibTeX>`_ types. In doing so, you can then simply use an ``\input`` command to embed all of these citations right in your document in an enumerated environment.
+
+You'll need the following in the header of your LaTeX cv file.
+
+.. code::
+
+  \usepackage{bibentry}
+  \newcommand{\enquote}[1]{``#1''}
+  \makeatletter\let\saved@bibitem\@bibitem\makeatother
+  \usepackage[colorlinks=true]{hyperref}
+  \makeatletter\let\@bibitem\saved@bibitem\makeatother
+
+The last 3 lines are only necessary if you want to use the ``hyperref`` package, which has some compatibility issues with bibentry.
+
+Then put:
+
+.. code::
+
+  \input{articles.tex}
+
+where you want articles listed, etc.
+
+Then, with your maintained `.bib` file, in the same location as your cv (for now), and **within the same directory as your cv and cv.bib file** open a python terminal and type.
+
+.. code::
+
+  >>> import vitae
+  >>> vitae.makemycv()
+
+Alternatively, you can type::
+
+  > python -c  "import vitae; vitae.makemycv()"
+
+in your terminal (Anaconda Terminal if you are using Anaconda Python on Windows).
+
+This will make your ``article.tex`` file along with the other defaults (see the help on ``makemycv``).
+
+Note that that are a ton of options for ``makemycv``. Please use::
+
+  >>> import vitae
+  >>> help(vitae.makemycv)
+
+To see how to tweak it to your needs.
+
+If you try ``vitae``, please understand:
+
+a. No warrantee. This is still a work in progress.
+b. Please provide your feedback.
+c. Please help! I can use help with additional portions.
+
+If you don't use LaTeX, this isn't easy enough for you yet. It's a long ways away. However, texblog_ has a decent start in writing a `Résumé in LaTeX`_ . It *doesn't* include the paper inclusion trick being used by ``vitae``.
+
+``write_bibs``
+~~~~~~~~~~~~~~
+
+The second function is ``write_bibs``. This allows you to convert bibs with a bunch of constraints into a format that pandoc_ can output. It REQUIRES a full `LaTeX`_ and pandoc_ installation that works in your terminal environment.
+
+Constraints include:
+
+1. Since a year
+2. Number
+3. Types of publications
+
+For instance:
+
+.. code::
+
+  >>> import vitae
+  >>> vitae.write_bibs(bibfile = '/Users/jslater/Documents/Resumes/cv.bib',
+                       bibliographystyle='aiaa',
+                       outfile_name='try.html',
+                       since_year=2008)
+
+Alternatively, from a command line::
+
+  > python -c  "import vitae; vitae.write_bibs(bibfile='cv.bib',
+                                               bibliographystyle='aiaa',
+                                               outfile_name = 'bibs.html',
+                                               since_year=2008)"
+
+How I use it
+------------
+
+I have a Makefile that I use for tasks that I am creating. The first is a simple one for building my cv, the contents of which are::
+
+	help:
+		@echo "Please use \`make <target>' where <target> is one of"
+		@echo "  cv         to make standard pdf cv"
+		@echo "  pdf        see cv"
+
+	cv:
+		python -c  'import vitae; vitae.makemycv(silent = True)'
+		pdflatex cv
+		bibtex cv
+		pdflatex cv
+
+	pdf:
+		cv
+
+Summary
+-------
+Please see the full help on each function.
+
+Vitae is on pypi_ but you can pip install the latest, and possibly non-working, version right now from github (I love bug reports!):
+
+.. code::
+
+  pip install git+https://github.com/josephcslater/vitae
+
+Help
+----
+``vitae`` uses luatex_ to enable unicode characters. On Ubuntu, the base tetex install doesn't include the necessary file ``luaotfload``. To resolve this open a terminal and type::
+
+  sudo apt install texlive-luatex
+
+Release notes:
+--------------
+
+See the CHANGELOG_ for the full history of releases.
+
+Future plans
+------------
+
+1. Preferences.
+
+  a. Reader (doesn't overwrite specified arguments)
+
+  b. Writer (configurator on call or when it doesn't exist)
+
+  c. Editor?
+
+2. Bug fixes when I find them. Any other suggestions?
+
+What else would be nice?
+
+.. _CHANGELOG: https://github.com/josephcslater/vitae/blob/master/CHANGELOG.rst
+.. _pandoc: http://pandoc.org
+.. _luatex: http://www.luatex.org
+.. _texblog: https://texblog.org
+.. _`Résumé in LaTeX`: https://texblog.org/2012/04/25/writing-a-cv-in-latex/
+.. _`LaTeX`: https://www.latex-tutorial.com/installation/
+.. _bibtexparser: https://bibtexparser.readthedocs.io/en/master/
+.. _Jupyter: https://www.Jupyter.org
+.. _Makefile: https://www.gnu.org/software/make/manual/html_node/Introduction.html
+.. _`demo Jupyter notebook`: https://github.com/josephcslater/vitae/blob/master/Vitae.ipynb
+.. _pypi: https://pypi.org/project/vitae/
+
+

vitae-1.1.4/setup.cfg

@@ -0,0 +1,18 @@
+[metadata]
+description-file = readme.rst
+
+[build_sphinx]
+source-dir = docs
+build-dir = docs/build
+all_files = 1
+
+[upload_sphinx]
+upload-dir = docs/build/html
+
+[bdist_wheel]
+python-tag = py35
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

vitae-1.1.4/setup.py

@@ -0,0 +1,43 @@
+#!/usr/bin/env python
+
+#from distutils.core import setup
+from setuptools import setup
+import os
+import sys
+
+if sys.version_info < (3, 5):
+    sys.exit('Sorry, Python < 3.5 is not supported.')
+# Utility function to read the README file.
+# Used for the long_description.  It's nice, because now 1) we have a top level
+# README file and 2) it's easier to type in the README file than to put a raw
+# string in below ...
+def read(fname):
+    return open(os.path.join(os.path.dirname(__file__), fname)).read()
+
+with open('vitae/__init__.py', 'rb') as fid:
+    for line in fid:
+        line = line.decode('utf-8')
+        if line.startswith('__version__'):
+            version = line.strip().split()[-1][1:-1]
+            break
+
+download_url = ('https://github.com/josephcslater/vitae/\
+                blob/master/dist/vitae-' + version + '.whl')
+
+
+setup(name='vitae',
+      version=version,
+      description=('Tools for academics for building a Curriculum Vitae and other oft-requested documents.'),
+      author=u'Joseph C. Slater',
+      author_email='joseph.c.slater@gmail.com',
+      url='https://github.com/josephcslater/vitae',
+      packages=['vitae'],
+      package_data={'vitae': ['../readme.rst', 'data/*.bib'],
+                    '': ['readme.rst']},
+      long_description=read('readme.rst'),
+      keywords=['curriculum vitae', 'academia', 'cv', 'resume'],
+      install_requires=['bibtexparser', 'appdirs'],
+      include_package_data=True
+      )
+
+# https://docs.python.org/3/distutils/setupscript.html#additional-meta-data

vitae-1.1.4/vitae/__init__.py

@@ -0,0 +1,26 @@
+from .vitae import *
+
+"""Vitae
+
+A set of tools for academics regularly needing updated CVs.
+Joseph C. Slater
+
+`import vitae`
+"""
+
+__title__ = 'vitae'
+__version__ = '1.1.4'
+__author__ = u'Joseph C. Slater'
+__license__ = 'BSD3'
+__copyright__ = 'Copyright 2018 Joseph C. Slater'
+__all__ = ['vitae',
+           '__version__']
+
+"""
+If the __all__ above is commented out, this code will then execute to
+completion, as the default behaviour of import * is to import all symbols
+that do not begin with an underscore, from the given namespace.
+
+Reference:
+https://docs.python.org/3.5/tutorial/modules.html#importing-from-a-package
+"""

vitae-1.1.4/vitae/vitae.py

@@ -0,0 +1,533 @@
+"""Create citation files from a bib file."""
+
+import bibtexparser
+import subprocess
+import tempfile
+from bibtexparser.bparser import BibTexParser
+from bibtexparser.customization import homogenize_latex_encoding
+import os
+from pathlib import Path
+
+
+def makemycv(filename='cv.bib',
+             silent=True,
+             bibtex_types=('inbook', 'article', 'periodical',
+                           'techreport', 'inproceedings'),
+             writeout=True,
+             indent='   ',
+             author=None,
+             outpath=None,
+             entrytypes=None):
+    r"""Create sub-bib TeX files for including into CV.abs
+
+    Written files with be names `entrytype```.tex`` to the current directory
+    if `outpath` is not defined. The files `entrytype```.tex`` will overwrite
+    files with the same name **without warning**.
+
+    Parameters
+    ----------
+    filename : string (optional: default cv.tex)
+        Name (including optional path) of bib file containing citation entries
+    bibtex_types : tuple of strings (optional)
+        List of bibtex bibtex_types to generate \bibentry .tex files for.
+        Files will be be named  `entrytype```.tex``
+    writeout : boolean (optional: default True)
+        Write to files. If false, only write to screenself.
+    indent : string
+        string of spaces for prettying up the item lists
+    author : string
+        select authors whose entries should be included.
+    outpath : string
+        output path to write files to.
+    silent : boolean (optional: default True)
+        print results to screen
+
+    Returns
+    -------
+    results : strings
+        Content(s) of each .tex file generated- in case you want them.
+    unaccounted : array
+        Array of bib entries not used in creation of the output.
+    bibs : array
+        Full array created by bibtexparser.
+
+    https://nwalsh.com/tex/texhelp/bibtx-7.html
+
+    Examples
+    --------
+    Makes tex files for inclusion in cv.tex (articles.tex, etc.).
+    See readme.rts on github.com
+    >>> import vitae
+    >>> vitae.makemycv(filename='cv.bib')
+
+    Alternatively from a terminal prompt:
+    > python -c  "import vitae; vitae.makemycv(filename='cv.bib')"
+
+    """
+    if entrytypes is not None:
+        print('entrytypes will be deprecated in future releases.')
+        print('Please use bibtex_types')
+        bibtex_types = entrytypes
+
+    if os.path.isfile(filename) is False:
+        print('{} is not an actual bib file.'.format(filename))
+        return
+
+    if outpath is None:
+        outpath = ''
+
+    if not os.path.isdir(outpath) and outpath != '':
+        print(outpath, ' is not a valid directory.')
+        return
+
+    parser = BibTexParser()
+    parser.customization = homogenize_latex_encoding
+    parser.ignore_nonstandard_types = False
+
+    with open(filename) as bibtex_file:
+        bib_database = bibtexparser.load(bibtex_file, parser)
+
+    bibs = bib_database.entries
+
+    if author is not None:
+        bibs = by_author(author, bibs)
+
+    results = {}
+
+    for entrytype in bibtex_types:
+        entry = [[bib['year'], bib['ID'], bib['title']]
+                 for bib in bibs if bib['ENTRYTYPE'] == entrytype]
+
+        entry_sorted = sorted(entry, key=lambda paper: paper[0], reverse=True)
+
+        if silent is False:
+            if entrytype[-1] == 's':
+                print('Number of {} is {}'.format(
+                    entrytype, len(entry_sorted)))
+            else:
+                print('Number of {}s is {}'.format(
+                    entrytype, len(entry_sorted)))
+
+        file_contents = '\\begin{enumerate}\n'
+        for entry in entry_sorted:
+            file_contents += indent + '\\item \\bibentry{' + entry[1] + '}\n'
+        file_contents += '\\end{enumerate}'
+        if writeout is True:
+            with open(os.path.join(outpath, entrytype + '.tex'), 'w') as file:
+                file.write(file_contents)
+        else:
+            print(file_contents)
+
+        results[entrytype] = file_contents
+
+    unaccounted = [bib for bib in bibs if bib['ENTRYTYPE'] not in bibtex_types]
+
+    if silent is False:
+        print('Unaccounted for entries is {}:'.format(len(unaccounted)))
+        for bib in unaccounted:
+            print(bib['ID'],
+                  '\n    ', bib['year'],
+                  '\n    ', bib['ENTRYTYPE'],
+                  '\n    ', bib['title'])
+
+    return results, unaccounted, bibs
+
+
+def by_author(authorname, bibs):
+    """Return only bibs containing authorname."""
+    keepindex = []
+    i = 0
+
+    an = authorname.replace(" ", "")
+
+    authorname = authorname.replace(',', ', ')
+    authorname = authorname.replace("  ", " ")
+
+    authorshort = 'xxxxxxx'
+    if ',' in authorname and len(an) > (1+an.find(',')):
+        authorshort = (authorname[:authorname.find(',')]
+                       + ', '
+                       + an[an.find(',')+1])
+
+    print('number of bibs', len(bibs))
+
+    for bib in bibs:
+        if 'author' in bib:
+            bibauthor = bib['author']
+            bibauthor = bibauthor.replace(',', ', ')
+            bibauthor = bibauthor.replace('  ', ' ')
+
+            if authorname in bibauthor:
+                keepindex.append(i)
+                i += 1
+            elif authorshort in bibauthor:
+                print('Close name WARNING- is bib entry correct?')
+                print(bib['author'], ': ', bib['title'])
+    author_bibs = [bibs[i] for i in keepindex]
+    return author_bibs
+
+
+def replace_enquote(string):
+    r"""Replace \enquote with proper quotes."""
+    front = string[:string.find(r'\enquote{')]
+    back = string[string.find(r'\enquote{'):].replace('}', "''", 1)
+    back = back.replace(r'\enquote{', '``')
+    return front + back
+
+
+def read_bbl(bblfilename):
+    """Read bbl file and return dictionary of formatted citations."""
+    if not is_tool('pdflatex') or not is_tool('bibtex'):
+        print("Both pdflatex and bibtex must exist on your command",
+              " line to use this function.")
+        return
+
+    isbibtext = 0
+    formattedbibs = {}
+    # print(bibtexparser)
+    bbl = open(bblfilename, "r")
+    for line in bbl:
+        if line[:6] == r'\begin' or line[:4] == r'\end':
+            pass
+        elif r'\providecommand' in line:
+            pass
+        elif r'bibitem' in line:
+            bibitem = line[line.find('{')+1: line.find('}')]
+            isbibtext = 1
+            bibtext = ''
+        elif isbibtext == 1:
+            if len(line) > 2:
+                bibtext += line.strip('\n')
+            elif len(line) < 2:
+                bibtext = replace_enquote(bibtext)
+                formattedbibs[bibitem] = bibtext
+                isbibtext = 0
+
+    return formattedbibs
+
+
+def formatted_bibs(bibfile, bibliographystyle='plain'):
+    """Make a dictionary of formatted bibs.
+
+    Parameters
+    ----------
+    bibfile : string
+        full path and file name to the .bib file
+    bibliographystyle : string (optional)
+        bst (bib style file) to use. Default: 'plain'
+
+    Returns
+    -------
+    formattedbibs : dictionary of strings
+        dictionary of formatted citations with Cite keys as keys.
+    bibs : array
+        bibfile array from bibtexparser
+
+    """
+#     path = os.path.dirname(bibfile)
+#     bibfilename = os.path.basename(bibfile)
+
+    bibliographystyle = bibliographystyle.replace('.bst', '')
+    old_directory = os.getcwd()
+
+    with tempfile.TemporaryDirectory() as tmpdirname:
+        os.chdir(tmpdirname)
+        with open('cv_temp.tex', 'w') as template:
+            # template.write('hello')
+            template_head = (r"""% !TEX root = cv.tex
+            \documentclass[12pt, letter]{article}
+            \usepackage[utf8]{inputenc}
+            \usepackage[T1]{fontenc}
+            \usepackage{bibentry}
+            \newcommand{\enquote}[1]{``#1''}
+            \makeatletter\let\saved@bibitem\@bibitem\makeatother
+            \usepackage[colorlinks=true]{hyperref}
+            \makeatletter\let\@bibitem\saved@bibitem\makeatother
+            \usepackage{url}{}
+            \renewcommand{\cite}{\bibentry}
+            \begin{document}
+            \nobibliography{"""
+                             + bibfile
+                             + r"""}
+            \bibliographystyle{"""
+                             + bibliographystyle
+                             + r"""}
+            \pagestyle{plain}
+            \input{article.tex}
+            \input{inbook.tex}
+            \input{inproceedings}
+            \input{periodical}
+            \input{techreport}
+            \end{document}""")
+            template.write(template_head)
+            _, _, bibs = makemycv(filename=bibfile, silent=True)
+
+        lualatex_result = subprocess.run(
+            ['lualatex', '-interaction=batchmode', 'cv_temp'])
+        if lualatex_result.returncode != 0:
+            print('lualatex failed to compile cv_temp.tex. '
+                  'Check the log for details.')
+
+        bibtex_result = subprocess.run(['bibtex', 'cv_temp'])
+        if bibtex_result.returncode != 0:
+            print('bibtex failed to process cv_temp.aux. '
+                  'Check the log for details.')
+
+        # print(os.path.join(tmpdirname, 'cv_temp.bbl'))
+        formattedbibs = read_bbl('cv_temp.bbl')
+
+        os.chdir(old_directory)  # Unnecessary
+    return formattedbibs, bibs
+
+
+def is_tool(name):
+    """Check whether `name` is on PATH and marked as executable."""
+    from shutil import which
+    return which(name) is not None
+
+
+def merge_formatted_into_db(formattedbibs, bibfilename=None, bibs=None):
+    """Create bib database including formated bibs."""
+    print('formattedbibs length', len(formattedbibs))
+    if bibs is None:
+        if bibfilename is None:
+            print('No bib file name given.')
+            return
+
+        if os.path.isfile(bibfilename) is False or 'bib' not in bibfilename:
+            print('{} is not an actual bib file.')
+            return
+
+        parser = BibTexParser()
+        parser.customization = homogenize_latex_encoding
+        parser.ignore_nonstandard_types = False
+
+        with open(bibfilename) as bibtex_file:
+            bib_database = bibtexparser.load(bibtex_file, parser, encoding='utf-8')
+
+        bibs = bib_database.entries
+
+    bib_database = [[bib['year'],
+                     bib['ID'],
+                     bib['title'],
+                     bib['ENTRYTYPE'],
+                     formattedbibs[bib['ID']]]
+                    for bib in bibs if bib['ID'] in formattedbibs.keys()]
+    print('bib_database formatted', len(bib_database))
+    return bib_database
+
+
+def write_bibs(bibfile=None,
+               bibliographystyle='plain',
+               outfile_name=None,
+               since_year=None,
+               number_citations=None,
+               bibtex_types=('articles',),
+               authorname=None,
+               outputformat=None,
+               silent=False,
+               standalone=True,
+               overwrite=False):
+    """Write formatted bibs from bibfile to desired format.
+
+    Parameters
+    ----------
+    bibfile : string
+        full path and file name to the .bib file
+    bibliographystyle : string (optional)
+        bst (bib style file) to use. Default: 'plain'.
+    outfile_name : string (optional)
+        name of output file. Default bibfile name with .tex extension. Default
+        output format is html.
+    since_year : integer (optional)
+        year of oldest citation to include. Default: All years.
+    number_citations : integer (optional)
+        maximum number of citations to include. Default: all.
+    bibtex_types : tuple of strings (optional)
+        list of types of entries to include. Default: ('articles')
+    authorname : string (optional)
+        author whos papers to include. Default: all.
+    silent : Boolean (optional)
+        display diagnostics. Default: False (will display diagnostics)
+    standalone : Boolean (optional)
+        By default, pandoc generates only a fragment. If you want a full
+        document set this to False. Default: True
+    overwrite : Boolean (optional)
+        Overwrite results files? Default: False
+
+    Examples
+    --------
+    To write citations to an html file:
+    >>> import vitae
+    >>> vitae.write_bibs(bibfile = '/Users/jslater/Documents/Resumes/cv.bib',
+                      bibliographystyle='plain',
+                      outfile_name='try.html',
+                      since_year=2008)
+
+    Alternatively, from a terminal prompt:
+    > python -c  "import vitae; vitae.write_bibs(bibfile='cv.bib',
+                                                 bibliographystyle='plain',
+                                                 outfile_name = 'bibs.html',
+                                                 since_year=2008)"
+
+
+    """
+    if '.bib' in outfile_name:
+        print('I refuse to write over a bib file. '
+              + 'While this software comes with no warrantee, '
+              + "I'm also not going to knowlingly cause you damage. "
+              + 'Please choose a more sensible output file name.')
+        return
+
+    if bibfile is None:
+        print('You must include the input named argument: bibfile')
+        print('This should include with full name with path.')
+        print('If the path is not included, cwd will be presumed.')
+        print('')
+        print('On Mac or Linux, this looks like:')
+        print('\'/Users/myusername/Documents/CVs/cv.bib\'')
+        print('')
+        print('On Windows, this looks like:')
+        print('r\'C:\\Users\\myusername\\Documents\\CVs\\cv.bib\'')
+        print('NOTE: The \'r\' may be necessary on Windows so that '
+              + '\'\\\' is not treated as an escape character.')
+        return
+
+    if os.path.isfile(bibfile) is False:
+        print(bibfile, ' cannot be found at that location.')
+        print('Please check path and try again.')
+        return
+
+    if (not is_tool('pdflatex')
+            or not is_tool('bibtex')
+            or not is_tool('pandoc')):
+
+        print("pdflatex, bibtex and pandoc must exist on your command",
+              " line to use this function.\n")
+        print("Please see the documentation at:")
+        print(r"https://github.com/josephcslater/vitae")
+        return
+
+    path = os.path.dirname(bibfile)
+
+    if path == '':
+        path = os.getcwd()
+        bibfile = os.path.join(path, bibfile)
+
+    bibfilename = os.path.basename(bibfile)
+    bibfilenameroot = bibfilename[:-4]
+
+    # No output file specified
+    if outfile_name is None:
+        outfile_name = bibfilenameroot + '.html'
+        outfile_name = os.path.join(path, outfile_name)
+
+    if os.path.dirname(outfile_name) == '':
+        path_output = path
+    else:
+        path_output = os.path.dirname(outfile_name)
+
+    if not os.path.isdir(path_output) and path_output != '':
+        print('Specified output path:')
+        print(path_output)
+        print('is not a valid path. Please play again.')
+        return
+
+    filename_output = os.path.basename(outfile_name)
+
+    root_output = filename_output
+
+    if '.' in filename_output:
+        root_output = filename_output[:filename_output.find('.')]
+
+    print(root_output)
+
+    # Format the bibs. We just format every one in the file, then use what we
+    # must later.
+    formattedbibs, bibs = formatted_bibs(bibfile,
+                                         bibliographystyle=bibliographystyle)
+
+    print('result of formatting bibs', len(formattedbibs))
+    bibs = merge_formatted_into_db(formattedbibs, bibs=bibs)
+
+    # Keep only bibs by chosen author.
+    if authorname is not None:
+        bibs = by_author(authorname, bibs)
+
+    # At this point, we have a bibs database with just bibs by authorname
+    # Next steps:
+
+    # 3. Truncate non-desired bibtex_types
+    bibs = [bib for bib in bibs if bib[3] in bibtex_types]
+
+    # Sort by date
+    bibs_sorted = sorted(bibs, key=lambda paper: paper[0], reverse=True)
+
+    # 2. Truncate older articles
+    if since_year is not None:
+        bibs_truncated = [bib for bib in bibs_sorted
+                          if int(bib[0]) >= since_year]
+    else:
+        bibs_truncated = bibs_sorted
+
+    # 4. Truncate beyond numberself.
+
+    if number_citations is not None and number_citations < len(bibs_truncated):
+        bibs_final = bibs_truncated[:number_citations]
+    else:
+        bibs_final = bibs_truncated
+
+    cwd = os.getcwd()
+
+    os.chdir(path_output)
+
+    outfile_name_tex = root_output + '.tex'
+
+    if os.path.isfile(outfile_name_tex) and not overwrite:
+        os.rename(outfile_name_tex, outfile_name_tex[:-4]+'_old.tex')
+
+    # routine to write out bibs_final bibsfinalfilename
+    with open(outfile_name_tex, 'w') as filename:
+        for bib in bibs_final:
+            filename.write(bib[4])
+            filename.write('\n')
+            filename.write('\n')
+
+    with open(outfile_name_tex) as f:
+        newText = f.read().replace('{\\em', '\\emph{')
+
+    with open(outfile_name_tex, "w") as f:
+        f.write(newText)
+
+    # Store old version of formatted references.
+    if os.path.isfile(filename_output) and not overwrite:
+        print('\n\n',
+              filename_output,
+              'moved to',
+              filename_output[:filename_output.find('.')]
+              + '_old'
+              + filename_output[filename_output.find('.'):],
+              '\n\n')
+        os.rename(filename_output,
+                  filename_output[:filename_output.find('.')]
+                  + '_old'
+                  + filename_output[filename_output.find('.'):])
+
+    pandoc_args = []
+
+    if standalone:
+        pandoc_args = ['-s', '-V', 'pagetitle:My Bibs', '-V', 'title:My Bibs']
+
+    pandoc_command = (['pandoc']
+                      + pandoc_args
+                      + [outfile_name_tex, '-o', filename_output])
+
+    pandoc_result = subprocess.run(pandoc_command)
+    if pandoc_result.returncode != 0:
+        print('pandoc failed to convert {} to {}.'.format(
+            outfile_name_tex, filename_output))
+    os.chdir(cwd)
+
+
+if __name__ == '__main__':
+    print('executing from command line')

vitae-1.1.4/vitae.egg-info/PKG-INFO

@@ -0,0 +1,198 @@
+Metadata-Version: 2.1
+Name: vitae
+Version: 1.1.4
+Summary: Tools for academics for building a Curriculum Vitae and other oft-requested documents.
+Home-page: https://github.com/josephcslater/vitae
+Author: Joseph C. Slater
+Author-email: joseph.c.slater@gmail.com
+License: UNKNOWN
+Keywords: curriculum vitae,academia,cv,resume
+Platform: UNKNOWN
+License-File: LICENSE
+
+
+.. image:: http://pepy.tech/badge/vitae
+   :target: http://pepy.tech/project/vitae
+   :alt: PyPi Download stats
+
+vitae
+=====
+
+A Python module for building curriculum vitae and other documents from a ``BibTeX`` file. ``vitae`` leverages bibtexparser_, `LaTeX`_, and pandoc_ to streamline getting citations of your papers into the formats you need quickly without manual intervention. Of course, with many settings, it can be a bit tedious. I personally recommend setting up a Jupyter_ notebook with the commands you regularly execute available there. Alternatively, you can call it from the terminal which allows it to work inside a more complex workflow.
+
+Purpose
+-------
+
+I hate formatting citations. It's tedious, and error-prone. Further, when I build my CV, I tend to muck it up and leave something out, mis-sort it, duplicate it accidentally, etc. So, I need a tool to do a better job with what is a menial task.
+
+Install
+-------
+
+.. code::
+
+  pip install vitae
+
+or
+
+.. code::
+
+   pip install --user vitae
+
+Usage
+-----
+
+Please see the brief `demo Jupyter notebook`_. It's very brief. I need to add more. The whole package is basically two functions. Please read the help:
+
+``makemycv``
+~~~~~~~~~~~~
+
+To do anything useful here, you must have `LaTeX`_ with BibTeX installed. If you don't use `LaTeX`_, this module isn't the place to start. Sorry.
+
+The first function here, ``makemycv``, will take a few arguments and put sorted ``\bibentry`` commands into ``.tex`` files with names corresponding to `BibTeX entry <https://en.wikibooks.org/wiki/LaTeX/Bibliography_Management#BibTeX>`_ types. In doing so, you can then simply use an ``\input`` command to embed all of these citations right in your document in an enumerated environment.
+
+You'll need the following in the header of your LaTeX cv file.
+
+.. code::
+
+  \usepackage{bibentry}
+  \newcommand{\enquote}[1]{``#1''}
+  \makeatletter\let\saved@bibitem\@bibitem\makeatother
+  \usepackage[colorlinks=true]{hyperref}
+  \makeatletter\let\@bibitem\saved@bibitem\makeatother
+
+The last 3 lines are only necessary if you want to use the ``hyperref`` package, which has some compatibility issues with bibentry.
+
+Then put:
+
+.. code::
+
+  \input{articles.tex}
+
+where you want articles listed, etc.
+
+Then, with your maintained `.bib` file, in the same location as your cv (for now), and **within the same directory as your cv and cv.bib file** open a python terminal and type.
+
+.. code::
+
+  >>> import vitae
+  >>> vitae.makemycv()
+
+Alternatively, you can type::
+
+  > python -c  "import vitae; vitae.makemycv()"
+
+in your terminal (Anaconda Terminal if you are using Anaconda Python on Windows).
+
+This will make your ``article.tex`` file along with the other defaults (see the help on ``makemycv``).
+
+Note that that are a ton of options for ``makemycv``. Please use::
+
+  >>> import vitae
+  >>> help(vitae.makemycv)
+
+To see how to tweak it to your needs.
+
+If you try ``vitae``, please understand:
+
+a. No warrantee. This is still a work in progress.
+b. Please provide your feedback.
+c. Please help! I can use help with additional portions.
+
+If you don't use LaTeX, this isn't easy enough for you yet. It's a long ways away. However, texblog_ has a decent start in writing a `Résumé in LaTeX`_ . It *doesn't* include the paper inclusion trick being used by ``vitae``.
+
+``write_bibs``
+~~~~~~~~~~~~~~
+
+The second function is ``write_bibs``. This allows you to convert bibs with a bunch of constraints into a format that pandoc_ can output. It REQUIRES a full `LaTeX`_ and pandoc_ installation that works in your terminal environment.
+
+Constraints include:
+
+1. Since a year
+2. Number
+3. Types of publications
+
+For instance:
+
+.. code::
+
+  >>> import vitae
+  >>> vitae.write_bibs(bibfile = '/Users/jslater/Documents/Resumes/cv.bib',
+                       bibliographystyle='aiaa',
+                       outfile_name='try.html',
+                       since_year=2008)
+
+Alternatively, from a command line::
+
+  > python -c  "import vitae; vitae.write_bibs(bibfile='cv.bib',
+                                               bibliographystyle='aiaa',
+                                               outfile_name = 'bibs.html',
+                                               since_year=2008)"
+
+How I use it
+------------
+
+I have a Makefile that I use for tasks that I am creating. The first is a simple one for building my cv, the contents of which are::
+
+	help:
+		@echo "Please use \`make <target>' where <target> is one of"
+		@echo "  cv         to make standard pdf cv"
+		@echo "  pdf        see cv"
+
+	cv:
+		python -c  'import vitae; vitae.makemycv(silent = True)'
+		pdflatex cv
+		bibtex cv
+		pdflatex cv
+
+	pdf:
+		cv
+
+Summary
+-------
+Please see the full help on each function.
+
+Vitae is on pypi_ but you can pip install the latest, and possibly non-working, version right now from github (I love bug reports!):
+
+.. code::
+
+  pip install git+https://github.com/josephcslater/vitae
+
+Help
+----
+``vitae`` uses luatex_ to enable unicode characters. On Ubuntu, the base tetex install doesn't include the necessary file ``luaotfload``. To resolve this open a terminal and type::
+
+  sudo apt install texlive-luatex
+
+Release notes:
+--------------
+
+See the CHANGELOG_ for the full history of releases.
+
+Future plans
+------------
+
+1. Preferences.
+
+  a. Reader (doesn't overwrite specified arguments)
+
+  b. Writer (configurator on call or when it doesn't exist)
+
+  c. Editor?
+
+2. Bug fixes when I find them. Any other suggestions?
+
+What else would be nice?
+
+.. _CHANGELOG: https://github.com/josephcslater/vitae/blob/master/CHANGELOG.rst
+.. _pandoc: http://pandoc.org
+.. _luatex: http://www.luatex.org
+.. _texblog: https://texblog.org
+.. _`Résumé in LaTeX`: https://texblog.org/2012/04/25/writing-a-cv-in-latex/
+.. _`LaTeX`: https://www.latex-tutorial.com/installation/
+.. _bibtexparser: https://bibtexparser.readthedocs.io/en/master/
+.. _Jupyter: https://www.Jupyter.org
+.. _Makefile: https://www.gnu.org/software/make/manual/html_node/Introduction.html
+.. _`demo Jupyter notebook`: https://github.com/josephcslater/vitae/blob/master/Vitae.ipynb
+.. _pypi: https://pypi.org/project/vitae/
+
+

vitae-1.1.4/vitae.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+setup.cfg
+setup.py
+vitae/__init__.py
+vitae/vitae.py
+vitae.egg-info/PKG-INFO
+vitae.egg-info/SOURCES.txt
+vitae.egg-info/dependency_links.txt
+vitae.egg-info/requires.txt
+vitae.egg-info/top_level.txt

vitae-1.1.4/vitae.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

vitae-1.1.4/vitae.egg-info/requires.txt

@@ -0,0 +1,2 @@
+bibtexparser
+appdirs

vitae-1.1.4/vitae.egg-info/top_level.txt

@@ -0,0 +1 @@
+vitae