dvcurator.pdf
=============

.. py:module:: dvcurator.pdf


Functions
---------

.. autoapisummary::

   dvcurator.pdf.find_pdfs
   dvcurator.pdf.combine_author_names
   dvcurator.pdf.write_metadata
   dvcurator.pdf.standard_metadata


Module Contents
---------------

.. py:function:: find_pdfs(path)

   Recursively find PDFs in a folder

   :param path: Path to look for PDFs under
   :type path: Path, as String
   :return: List of PDFs, as relative paths
   :rtype: list[str]


.. py:function:: combine_author_names(citation)

   Generate the string for the PDF metadata field "author". Separate with semicolons between full names for > 1 author

   :param citation: Project citation, generated by `get_citation()`
   :type citation: list[str]
   :return: Author names formatted to input as PDF metadata
   :rtype: None



.. py:function:: write_metadata(folder, author)

   Write metadata to PDF files

   :param folder: folder of the PDF files
   :type folder: string
   :param author: contents of the new author metadata field
   :type author: string


.. py:function:: standard_metadata(folder, citation)

   Standardize PDF metadata according to QDR specifications

   :param folder: Folder with PDFs to edit (searches recursively)
   :type folder: Path, as string
   :param citation: Project citation, generated by `get_citation()`
   :type citation: list[str]
   :return: Path to new folder with the standardized PDF files, or None if error
   :rtype: Path, as string