Update metadata.py

For documentation

.github/workflows/pythonpublish.yml

@@ -2,7 +2,7 @@ name: Upload Python Package
 
 on:
   release:
-    types: [created]
+    types: [published]
 
 jobs:
   deploy:
@@ -20,7 +20,7 @@ jobs:
     - name: Build and publish
       env:
         TWINE_USERNAME: __token__
-        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_APIKEY }}
       run: |
         python setup.py sdist bdist_wheel
         twine upload dist/*

.readthedocs.yaml

@@ -0,0 +1,29 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.10"
+    # You can also specify other tool versions:
+    # nodejs: "16"
+    # rust: "1.55"
+    # golang: "1.17"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/source/conf.py
+
+#If using Sphinx, optionally build your docs in additional formats such as PDF
+formats:
+   - pdf
+
+#Optionally declare the Python requirements required to build your docs
+python:
+   install:
+   - requirements: requirements.txt

README.md

@@ -1,8 +1,6 @@
 [![Documentation Status](https://readthedocs.org/projects/wavinfo/badge/?version=latest)](https://wavinfo.readthedocs.io/en/latest/?badge=latest) ![](https://img.shields.io/github/license/iluvcapra/wavinfo.svg) ![](https://img.shields.io/pypi/pyversions/wavinfo.svg) [![](https://img.shields.io/pypi/v/wavinfo.svg)](https://pypi.org/project/wavinfo/) ![](https://img.shields.io/pypi/wheel/wavinfo.svg)
 ![Lint and Test](https://github.com/iluvcapra/wavinfo/actions/workflows/python-package.yml/badge.svg)
 
-<!-- ![Test](https://github.com/iluvcapra/wavinfo/workflows/Upload%20Python%20Package/badge.svg) -->
-
 # wavinfo
 
 The `wavinfo` package allows you to probe WAVE and [RF64/WAVE files][eburf64] and extract extended metadata, with an emphasis on film, video and professional music production metadata.

docs/Makefile

@@ -4,7 +4,7 @@
 # You can set these variables from the command line.
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
-SOURCEDIR     = .
+SOURCEDIR     = source
 BUILDDIR      = _build
 
 # Put it first so that "make" without argument is like "make help".
@@ -16,4 +16,4 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -1,35 +0,0 @@
-@ECHO OFF
-
-pushd %~dp0
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=sphinx-build
-)
-set SOURCEDIR=.
-set BUILDDIR=_build
-
-if "%1" == "" goto help
-
-%SPHINXBUILD% >NUL 2>NUL
-if errorlevel 9009 (
-	echo.
-	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
-	echo.installed, then set the SPHINXBUILD environment variable to point
-	echo.to the full path of the 'sphinx-build' executable. Alternatively you
-	echo.may add the Sphinx directory to PATH.
-	echo.
-	echo.If you don't have Sphinx installed, grab it from
-	echo.http://sphinx-doc.org/
-	exit /b 1
-)
-
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
-goto end
-
-:help
-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
-
-:end
-popd

docs/source/classes.rst

@@ -0,0 +1,18 @@
+Other wavinfo Classes
+===============
+
+
+.. autoclass:: wavinfo.wave_reader.WavInfoReader
+   :members:
+
+   .. automethod:: __init__
+   
+
+.. autoclass:: wavinfo.wave_reader.WavAudioFormat
+   :members:
+
+.. autoclass:: wavinfo.wave_reader.WavDataDescriptor
+   :members:
+
+
+

docs/source/conf.py

@@ -14,19 +14,21 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath('../..'))
+sys.path.insert(0, os.path.abspath("../../.."))
+print(sys.path)
 
 
 # -- Project information -----------------------------------------------------
 
 project = u'wavinfo'
-copyright = u'2019, Jamie Hardt'
+copyright = u'2022, Jamie Hardt'
 author = u'Jamie Hardt'
 
 # The short X.Y version
 version = u''
 # The full version, including alpha/beta/rc tags
-release = u'v1.1'
+release = u'v1.7.1'
 
 
 # -- General configuration ---------------------------------------------------
@@ -61,7 +63,7 @@ master_doc = 'index'
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

docs/source/index.rst

@@ -6,30 +6,15 @@
 Welcome to wavinfo's documentation!
 ===================================
 
-
-.. module:: wavinfo
-
-.. autoclass:: WavInfoReader
-   :members:
-
-   .. automethod:: __init__
-   
-
-.. autoclass:: wavinfo.wave_reader.WavAudioFormat
-   :members:
-
-.. autoclass:: wavinfo.wave_reader.WavDataDescriptor
-   :members:
-
-
 .. toctree::
    :maxdepth: 2
    :caption: Notes:
-   
+  
    metadata_scopes/bext.rst
    metadata_scopes/ixml.rst
    metadata_scopes/info.rst
 
+   classes
 
 
 Indices and tables

docs/source/metadata_scopes/bext.rst

@@ -1,11 +1,6 @@
 Broadcast WAV Extension
 =======================
 
-.. module:: wavinfo
-
-.. autoclass:: wavinfo.wave_bext_reader.WavBextReader
-   :members:
-
 
 Notes
 -----
@@ -63,3 +58,14 @@ Result:
     Originator Time: 12:40:00
     Time Reference: 2190940753
     A=PCM,F=48000,W=24,M=stereo,R=48000,T=2 Ch
+
+
+Class Reference
+---------------
+
+.. module:: wavinfo
+
+.. autoclass:: wavinfo.wave_bext_reader.WavBextReader
+   :members:
+
+

docs/source/metadata_scopes/info.rst

@@ -1,14 +1,6 @@
 INFO Metadata
 =============
 
-
-.. module:: wavinfo
-
-.. autoclass:: wavinfo.wave_info_reader.WavInfoChunkReader
-   :members:
-
-
-
 Notes
 -----
 
@@ -28,5 +20,14 @@ music library software.
     print("INFO Comment:",   bullet.info.comment)
 
 
+Class Reference
+---------------
+
+.. module:: wavinfo
+
+.. autoclass:: wavinfo.wave_info_reader.WavInfoChunkReader
+   :members:
+
+
 
 

docs/source/metadata_scopes/ixml.rst

@@ -1,13 +1,6 @@
 iXML Production Recorder Metadata
 =================================
 
-
-.. module:: wavinfo
-
-.. autoclass:: wavinfo.wave_ixml_reader.WavIXMLFormat
-   :members:
-
-
 Notes
 -----
 iXML allows an XML document to be embedded in a WAV file.
@@ -41,4 +34,12 @@ Result:
     iXML File Family UID: USSDVGR1112089007124001008206300
 
 
+Class Reference
+---------------
+
+.. module:: wavinfo
+
+.. autoclass:: wavinfo.wave_ixml_reader.WavIXMLFormat
+   :members:
+
 

metadata.py

@@ -1,6 +1,6 @@
 """
 Wavinfo
 """
-__version__ = '1.7.0'
+__version__ = '1.7.1'
 __author__ = 'Jamie Hardt <jamiehardt@gmail.com>'
 __license__ = "MIT"

wavinfo/umid_parser.py

@@ -1,5 +1,3 @@
-from typing import Union
-import binascii
 from functools import reduce
 
 
@@ -13,7 +11,7 @@ class UMIDParser:
 
     This implementation is based on SMPTE ST 330:2011
     """
-    def __init__(self, raw_umid: bytearray):
+    def __init__(self, raw_umid: bytes):
         self.raw_umid = raw_umid
     #
     # @property

wavinfo/wave_bext_reader.py

@@ -1,7 +1,7 @@
 import struct
-import binascii
 from .umid_parser import UMIDParser
 
+from typing import Optional
 
 class WavBextReader:
     def __init__(self, bext_data, encoding):
@@ -16,44 +16,44 @@ class WavBextReader:
         rest_starts = struct.calcsize(packstring)
         unpacked = struct.unpack(packstring, bext_data[:rest_starts])
 
-        def sanitize_bytes(b):
+        def sanitize_bytes(b : bytes) -> str:
             first_null = next((index for index, byte in enumerate(b) if byte == 0), None)
             trimmed = b if first_null is None else b[:first_null]
             decoded = trimmed.decode(encoding)
             return decoded
 
         #: Description. A free-text field up to 256 characters long.
-        self.description = sanitize_bytes(unpacked[0])
+        self.description : str = sanitize_bytes(unpacked[0])
         #: Originator. Usually the name of the encoding application, sometimes
         #: a artist name.
-        self.originator = sanitize_bytes(unpacked[1])
+        self.originator : str = sanitize_bytes(unpacked[1])
         #: A unique identifier for the file, a serial number.
-        self.originator_ref = sanitize_bytes(unpacked[2])
+        self.originator_ref : str = sanitize_bytes(unpacked[2])
         #: Date of the recording, in the format YYY-MM-DD
-        self.originator_date = sanitize_bytes(unpacked[3])
+        self.originator_date : str = sanitize_bytes(unpacked[3])
         #: Time of the recording, in the format HH:MM:SS.
-        self.originator_time = sanitize_bytes(unpacked[4])
+        self.originator_time : str = sanitize_bytes(unpacked[4])
         #: The sample offset of the start of the file relative to an
         #: epoch, usually midnight the day of the recording. 
-        self.time_reference = unpacked[5]
+        self.time_reference : int  = unpacked[5]
         #: A variable-length text field containing a list of processes and
         #: and conversions performed on the file.
-        self.coding_history = sanitize_bytes(bext_data[rest_starts:])
+        self.coding_history : str = sanitize_bytes(bext_data[rest_starts:])
         #: BEXT version. 
-        self.version = unpacked[6]
+        self.version : int = unpacked[6]
         #: SMPTE 330M UMID of this audio file, 64 bytes are allocated though the UMID
         #: may only be 32 bytes long.
-        self.umid = None
+        self.umid : Optional[bytes] = None
         #: EBU R128 Integrated loudness, in LUFS.
-        self.loudness_value = None
+        self.loudness_value : Optional[float] = None
         #: EBU R128 Loudness rante, in LUFS.
-        self.loudness_range = None
+        self.loudness_range : Optional[float] = None
         #: True peak level, in dBFS TP
-        self.max_true_peak = None
+        self.max_true_peak : Optional[float] = None
         #: EBU R128 Maximum momentary loudness, in LUFS
-        self.max_momentary_loudness = None
+        self.max_momentary_loudness : Optional[float] = None
         #: EBU R128 Maximum short-term loudness, in LUFS.
-        self.max_shortterm_loudness = None
+        self.max_shortterm_loudness : Optional[float] = None
 
         if self.version > 0:
             self.umid = unpacked[7]

wavinfo/wave_info_reader.py

@@ -1,5 +1,6 @@
 from .riff_parser import parse_chunk, ListChunkDescriptor
 
+from typing import Optional
 
 class WavInfoChunkReader:
 
@@ -14,40 +15,40 @@ class WavInfoChunkReader:
         self.info_chunk = next((chunk for chunk in list_chunks if chunk.signature == b'INFO'), None)
 
         #: 'ICOP' Copyright
-        self.copyright = self._get_field(f, b'ICOP')
+        self.copyright : Optional[str] = self._get_field(f, b'ICOP')
         #: 'IPRD' Product
-        self.product = self._get_field(f, b'IPRD')
-        self.album = self.product
+        self.product : Optional[str]= self._get_field(f, b'IPRD')
+        self.album : Optional[str] = self.product
         #: 'IGNR' Genre
-        self.genre = self._get_field(f, b'IGNR')
+        self.genre : Optional[str] = self._get_field(f, b'IGNR')
         #: 'ISBJ' Supject
-        self.subject = self._get_field(f, b'ISBJ')
+        self.subject : Optional[str] = self._get_field(f, b'ISBJ')
         #: 'IART' Artist, composer, author
-        self.artist = self._get_field(f, b'IART')
+        self.artist : Optional[str] = self._get_field(f, b'IART')
         #: 'ICMT' Comment
-        self.comment = self._get_field(f, b'ICMT')
+        self.comment : Optional[str] = self._get_field(f, b'ICMT')
         #: 'ISFT' Software, encoding application
-        self.software = self._get_field(f, b'ISFT')
+        self.software : Optional[str] = self._get_field(f, b'ISFT')
         #: 'ICRD' Created date
-        self.created_date = self._get_field(f, b'ICRD')
+        self.created_date : Optional[str] = self._get_field(f, b'ICRD')
         #: 'IENG' Engineer
-        self.engineer = self._get_field(f, b'IENG')
+        self.engineer : Optional[str] = self._get_field(f, b'IENG')
         #: 'ITCH' Technician
-        self.technician = self._get_field(f, b'ITCH')
+        self.technician : Optional[str] = self._get_field(f, b'ITCH')
         #: 'IKEY' Keywords, keyword list
-        self.keywords = self._get_field(f, b'IKEY')
+        self.keywords : Optional[str] = self._get_field(f, b'IKEY')
         #: 'INAM' Name, title
-        self.title = self._get_field(f, b'INAM')
+        self.title : Optional[str] = self._get_field(f, b'INAM')
         #: 'ISRC' Source
-        self.source = self._get_field(f, b'ISRC')
+        self.source : Optional[str] = self._get_field(f, b'ISRC')
         #: 'TAPE' Tape
-        self.tape = self._get_field(f, b'TAPE')
+        self.tape : Optional[str] = self._get_field(f, b'TAPE')
         #: 'IARL' Archival Location
-        self.archival_location = self._get_field(f, b'IARL')
+        self.archival_location : Optional[str] = self._get_field(f, b'IARL')
         #: 'ICSM' Commissioned
-        self.commissioned = self._get_field(f, b'ICMS')
+        self.commissioned : Optional[str] = self._get_field(f, b'ICMS')
 
-    def _get_field(self, f, field_ident):
+    def _get_field(self, f, field_ident) -> Optional[str]:
         search = next(((chunk.start, chunk.length) for chunk in self.info_chunk.children if chunk.ident == field_ident),
                       None)
 

wavinfo/wave_ixml_reader.py

@@ -1,7 +1,7 @@
 from lxml import etree as ET
 import io
 from collections import namedtuple
-
+from typing import Optional
 
 IXMLTrack = namedtuple('IXMLTrack', ['channel_index', 'interleave_index', 'name', 'function'])
 
@@ -20,10 +20,12 @@ class WavIXMLFormat:
         parser = ET.XMLParser(recover=True)
         self.parsed = ET.parse(xml_bytes, parser=parser)
 
-    def _get_text_value(self, xpath):
+    def _get_text_value(self, xpath) -> Optional[str]:
         e = self.parsed.find("./" + xpath)
         if e is not None:
             return e.text
+        else: 
+            return None
 
     @property
     def raw_xml(self):
@@ -46,35 +48,35 @@ class WavIXMLFormat:
                                 function=track.xpath('string(FUNCTION/text())'))
 
     @property
-    def project(self):
+    def project(self) -> Optional[str]:
         """
         The project/film name entered for the recording.
         """
         return self._get_text_value("PROJECT")
 
     @property
-    def scene(self):
+    def scene(self) -> Optional[str]:
         """
         Scene/slate.
         """
         return self._get_text_value("SCENE")
 
     @property
-    def take(self):
+    def take(self) ->  Optional[str]:
         """
         Take number.
         """
         return self._get_text_value("TAKE")
 
     @property
-    def tape(self):
+    def tape(self) -> Optional[str]:
         """
         Tape name.
         """
         return self._get_text_value("TAPE")
 
     @property
-    def family_uid(self):
+    def family_uid(self) -> Optional[str]:
         """
         The globally-unique ID for this file family. This may be in the format
         of a GUID, or an EBU Rec 9 source identifier, or some other dumb number.
@@ -82,7 +84,7 @@ class WavIXMLFormat:
         return self._get_text_value("FILE_SET/FAMILY_UID")
 
     @property
-    def family_name(self):
+    def family_name(self) -> Optional[str]:
         """
         The name of this file's file family.
         """