Update documentation and bump version number

Author: NumerousHats

HISTORY.md

@@ -1,5 +1,13 @@
 # History
 
+### 3.4.0 (2019-12-14)
+
+* Add capability to toggle between existing, tempate, and edited metadata
+* Add IARL
+* Add additional XMP MD fields
+* Add bwf2pbcore and bwf2csv tools
+
+
 ### 3.3.1 (2019-07-22)
 
 * Add "--config" argument to autoBWF

docs/conf.py

@@ -22,7 +22,7 @@
 author = 'Michael Andrec/UHEC'
 
 # The full version, including alpha/beta/rc tags
-release = '3.3.1'
+release = '3.4.0'
 
 
 # -- General configuration ---------------------------------------------------

docs/index.rst

@@ -15,8 +15,8 @@ content based on file naming conventions, system metadata, and pre-configured re
 can copy metadata fields from a template file to avoid having to enter the same information multiple times
 for derivative files of the same physical instantiation.
 
-Also included are two command line programs (``autosplice`` and ``autolame``) which simplify the creation
-of derivative files.
+Also included are auxilliary command line scripts which simplify the creation
+of derivative files and provide for export of embedded metadata to PBCore and CSV files.
 
 Contents
 ++++++++++++
@@ -35,5 +35,5 @@ Known issues
   may cause a change to the modification time for the directory, which could cause a problem for some digital
   preservation schemes.
 * ``autoBWF`` strives to write valid XMP, but when reading Wave files it makes significant assumptions about
-  the structure of the XMP XML beyond those mandated by the XMP standard. Therefore, it is capable of reliably
-  reading only XMP generated by ``autoBWF`` itself, and metadata written by other software may not be correctly parsed.
+  the structure of the XMP XML beyond those mandated by the XMP standard. Therefore, it is only capable of reliably
+  reading XMP generated by ``autoBWF`` itself, and metadata written by other software may not be correctly parsed.

docs/installation.rst

@@ -8,8 +8,8 @@ Python 3
 ------------
 
 This code requires Python 3.6 or later. If you are running on Linux or Mac OS,
-then it is almost certainly already installled. If you are running on Widows,
-you can install Python using instructions that can be found on any number of web
+then it is almost certainly already installed. If you are running on Widows,
+you can install Python using instructions on any number of web
 sites (such as `this one
 <https://www.digitalocean.com/community/tutorials/how-to-install-
 python-3-and-set-up-a-local-programming-environment-on-windows-10>`_).
@@ -20,10 +20,10 @@ run ``autoBWF``.
 
 bwfmetaedit
 ----------------------------
-Download the and run the installer for the `BWFMetaEdit
+If needed, download and run the installer for the `BWFMetaEdit
 <https://mediaarea.net/BWFMetaEdit>`_ CLI (Command Line Interface) appropriate
 to your operating system from `mediaarea.net <https://mediaarea
-.net/BWFMetaEdit/Download>`_. Note that simply having the BWFMetaEdit GUI
+.net/BWFMetaEdit/Download>`_. Note that having the BWFMetaEdit GUI
 installed is not sufficient.
 
 ``autoBWF`` has been tested with ``bwfmetaedit`` v1.3.3 and v1.3.8. Note that
@@ -58,5 +58,5 @@ and installing the local code with ``pip3``, or by running ::
 
     pip3 install git+git://github.com/Ukrainian-History/autoBWF.git#egg=autoBWF
 
-The master branch contains functional code - all development work that is likely
+The master branch *should* contain functional code — development work that is likely
 to result in a broken state is done on feature branches.

docs/splicelame.rst

@@ -1,4 +1,4 @@
-Autosplice and autolame
+Auxilliary tools
 ===========================
 
 autosplice
@@ -45,7 +45,7 @@ Security note
 ``subprocess.call()`` function with the ``shell=True`` argument. This is a
 theorectical security risk, as a maliciously-crafted EDL file obtained from an
 untrusted source could result in a shell injection attack. It is mitigated by the
-fact that such a malicious file should be easily recognizable by simple visual
+fact that such a malicious file would be easily detectable by simple visual
 inspection.
 
 autolame
@@ -57,9 +57,38 @@ Usage::
 
 Each `<infile>` will be converted to mp3 and the result will be saved to the same
 file name with the extension changed to mp3. Multiple <infile>s can be given, or
-generated using a shell glob (e.g. `*.wav`)
+generated using a shell glob (e.g. `*.wav`). Selected embedded metadata values from the BWF
+files are migrated to ID3v2 tags in the resulting mp3 files.
 
 An output file name can be specified using the ``-o`` option, but in that case
 only one input file is allowed.
 
-The default VBR level is currently 7.
+The default VBR level is currently 7.
+
+bwf2pbcore
+------------------
+
+Usage::
+
+    bwf2pbcore [-h] infile [infile ...]
+
+Embeded Wave metadata in each `<infile>` will be extracted and saved as a PBCore XML sidecar file.
+The filename of the generated sidecar file will be the same as that of `<infile>` with
+"_pbcore" inserted just before the ".xml" extension (i.e. the input file "foobar.wav" will
+result in a sidecar file with the name "foobar_pbcore.xml")
+
+`bwf2pbcore` checks for the presence of a file with the same name as the `<infile>`, but with
+"_ohms.xml" as a suffix and extension (i.e. for the input file "foobar.wav", it will look for the
+file "foobar_ohms.xml"). If such a file is found, it will assume that it contains XML metadata exported from
+the Oral History Metadata Synchronizer, and the contents will be inserted into the PBCore XML
+within an instantiation-level `<extensionEmbedded>` element.
+
+bwf2csv
+------------------
+
+Usage::
+
+    bwf2csv [-h] infile [infile ...]
+
+Selected elements of embeded Wave metadata in each `<infile>` will be extracted and output to `stdout` in CSV format (one line
+per Wave file).

setup.py

@@ -39,6 +39,6 @@
     packages=find_packages(include=['autoBWF']),
     setup_requires=setup_requirements,
     url='https://github.com/Ukrainian-History/autoBWF',
-    version='3.3.1',
+    version='3.4.0',
     zip_safe=False,
 )