Relative volume adjustments (RVA2 and RVAD) (#399)

* new: Tag properties copyright and encoded_by * new: Plugins more featured in docs * fix: dev: Docs module name lowercase
nicfit · Mar 22, 2020 · c3db1b4 · c3db1b4
1 parent a7c15db
commit c3db1b4
Show file tree

Hide file tree

Showing 23 changed files with 846 additions and 221 deletions.
diff --git a/Makefile b/Makefile
@@ -130,7 +130,7 @@ coverage-view:
 docs:
 	rm -f docs/eyed3.rst
 	rm -f docs/modules.rst
-	sphinx-apidoc --force -H $(PROJECT_NAME) -V $(VERSION) -o docs/ ${SRC_DIRS}
+	sphinx-apidoc --force -H "$(shell echo $(PROJECT_NAME) | tr '[:upper:]' '[:lower:]') module" -V $(VERSION) -o docs/ ${SRC_DIRS}
 	$(MAKE) -C docs clean
 	etc/mycog.py
 	$(MAKE) -C docs html
@@ -239,12 +239,12 @@ pypi-release:
         fi \
 	done
 
-sdist: build
+sdist: clean build
 	python setup.py sdist --formats=gztar,zip
 	python setup.py bdist_egg
 	python setup.py bdist_wheel
 
-dist: clean sdist docs-dist
+dist: sdist docs-dist
 	@# The cd dist keeps the dist/ prefix out of the md5sum files
 	cd dist && \
 	for f in $$(ls); do \

diff --git a/docs/cli.rst b/docs/cli.rst
@@ -46,21 +46,7 @@ Plugins
 .. toctree::
    :maxdepth: 1
 
-   plugins/art_plugin
-   plugins/classic_plugin
-   plugins/display_plugin
-   plugins/extract_plugin
-   plugins/fixup_plugin
-   plugins/itunes_plugin
-   plugins/json_plugin
-   plugins/genres_plugin
-   plugins/lameinfo_plugin
-   plugins/mimetypes_plugin
-   plugins/nfo_plugin
-   plugins/pymod_plugin
-   plugins/stats_plugin
-   plugins/xep118_plugin
-   plugins/yaml_plugin
+   plugins
 
 .. _config-files:
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -32,8 +32,9 @@ Documentation
     :maxdepth: 2
 
     cli
-    compliance
+    plugins
     modules
+    compliance
     contributing
     authors
 
@@ -55,7 +56,7 @@ References
 ==========
 - ID3 `v1.x Specification <http://id3lib.sourceforge.net/id3/id3v1.html>`_
 - ID3 v2.4 `Structure <http://www.id3.org/id3v2.4.0-structure>`_ and
-  `Frames <http://www.id3.org/id3v2.4.0-frames>`_ 
+  `Frames <http://www.id3.org/id3v2.4.0-frames>`_
 - ID3 `v2.3 Specification <http://www.id3.org/id3v2.3.0>`_
 - ID3 `v2.2 Specification <http://www.id3.org/id3v2-00>`_
 - ISO `8601 Date and Time <http://www.cl.cam.ac.uk/~mgk25/iso-time.html>`_

diff --git a/docs/modules.rst b/docs/modules.rst
@@ -1,5 +1,5 @@
-eyeD3
-=====
+eyed3 module
+============
 
 .. toctree::
    :maxdepth: 4

diff --git a/docs/plugins.rst b/docs/plugins.rst
@@ -0,0 +1,20 @@
+Plugins
+--------
+.. toctree::
+   :maxdepth: 2
+
+   plugins/art_plugin
+   plugins/classic_plugin
+   plugins/display_plugin
+   plugins/extract_plugin
+   plugins/fixup_plugin
+   plugins/itunes_plugin
+   plugins/json_plugin
+   plugins/genres_plugin
+   plugins/lameinfo_plugin
+   plugins/mimetypes_plugin
+   plugins/nfo_plugin
+   plugins/pymod_plugin
+   plugins/stats_plugin
+   plugins/xep118_plugin
+   plugins/yaml_plugin
diff --git a/docs/plugins/classic_plugin.rst b/docs/plugins/classic_plugin.rst
diff --git a/docs/plugins/fixup_plugin.rst b/docs/plugins/fixup_plugin.rst
@@ -72,25 +72,35 @@ Options
 -------
 .. code-block:: text
 
+    - All other types: ${artist} - ${track:num} - ${title} - A rename template can be supplied in --file-rename-pattern 12. Directories are renamed as
+    follows: - Type ``live``: ${best_date:prefer_recording} - ${album} - All other types: ${best_date:prefer_release} - ${album} - A rename template can be
+    supplied in --dir-rename-pattern Album types: - ``lp``: A traditinal "album" of songs from a single artist. No extra info is written to the tag since
+    this is the default. - ``ep``: A short collection of songs from a single artist. The string 'ep' is written to the tag's ``eyeD3#album_type`` field. -
+    ``various``: A collection of songs from different artists. The string 'various' is written to the tag's ``eyeD3#album_type`` field. - ``live``: A
+    collection of live recordings from a single artist. The string 'live' is written to the tag's ``eyeD3#album_type`` field. - ``compilation``: A
+    collection of songs from various recordings by a single artist. The string 'compilation' is written to the tag's ``eyeD3#album_type`` field. Compilation
+    dates, unlike other types, may differ. - ``demo``: A demo recording by a single artist. The string 'demo' is written to the tag's ``eyeD3#album_type``
+    field. - ``single``: A track that should no be associated with an album (even if it has album metadata). The string 'single' is written to the tag's
+    ``eyeD3#album_type`` field.
+  
     --type {lp,ep,compilation,live,various,demo,single}
-                          How to treat each directory. The default is 'lp', although you may be prompted for an alternate choice if
-                          the files look like another type.
+                          How to treat each directory. The default is 'lp', although you may be prompted for an alternate choice if the files look like
+                          another type.
     --fix-case            Fix casing on each string field by capitalizing each word.
     -n, --dry-run         Only print the operations that would take place, but do not execute them.
     --no-prompt           Exit if prompted.
     --dotted-dates        Separate date with '.' instead of '-' when naming directories.
     --file-rename-pattern FILE_RENAME_PATTERN
-                          Rename file (the extension is not affected) based on data in the tag using substitution variables: $album,
-                          $album_artist, $artist, $best_date, $best_date:prefer_recording, $best_date:prefer_recording:year,
-                          $best_date:prefer_release, $best_date:prefer_release:year, $best_date:year, $disc:num, $disc:total, $file,
-                          $file:ext, $original_release_date, $original_release_date:year, $recording_date, $recording_date:year,
-                          $release_date, $release_date:year, $title, $track:num, $track:total
-    --dir-rename-pattern DIR_RENAME_PATTERN
-                          Rename directory based on data in the tag using substitution variables: $album, $album_artist, $artist,
+                          Rename file (the extension is not affected) based on data in the tag using substitution variables: $album, $album_artist, $artist,
                           $best_date, $best_date:prefer_recording, $best_date:prefer_recording:year, $best_date:prefer_release,
-                          $best_date:prefer_release:year, $best_date:year, $disc:num, $disc:total, $file, $file:ext,
-                          $original_release_date, $original_release_date:year, $recording_date, $recording_date:year, $release_date,
-                          $release_date:year, $title, $track:num, $track:total
+                          $best_date:prefer_release:year, $best_date:year, $disc:num, $disc:total, $file, $file:ext, $original_release_date,
+                          $original_release_date:year, $recording_date, $recording_date:year, $release_date, $release_date:year, $title, $track:num,
+                          $track:total
+    --dir-rename-pattern DIR_RENAME_PATTERN
+                          Rename directory based on data in the tag using substitution variables: $album, $album_artist, $artist, $best_date,
+                          $best_date:prefer_recording, $best_date:prefer_recording:year, $best_date:prefer_release, $best_date:prefer_release:year,
+                          $best_date:year, $disc:num, $disc:total, $file, $file:ext, $original_release_date, $original_release_date:year, $recording_date,
+                          $recording_date:year, $release_date, $release_date:year, $title, $track:num, $track:total
 
 
 .. {{{end}}}
diff --git a/docs/plugins/itunes_plugin.rst b/docs/plugins/itunes_plugin.rst
@@ -34,19 +34,19 @@ Example
 
   $ eyeD3 -P itunes-podcast example.id3
 
-  /home/travis/devel/eyeD3/example.id3
+  /home/travis/devel/eyeD3/git/example.id3
   	iTunes podcast? :-(
 
   $ eyeD3 -P itunes-podcast example.id3 --add
 
-  /home/travis/devel/eyeD3/example.id3
+  /home/travis/devel/eyeD3/git/example.id3
   	iTunes podcast? :-(
   	Adding...
   	iTunes podcast? :-)
 
   $ eyeD3 -P itunes-podcast example.id3 --remove
 
-  /home/travis/devel/eyeD3/example.id3
+  /home/travis/devel/eyeD3/git/example.id3
   	iTunes podcast? :-)
   	Removing...
   	iTunes podcast? :-(

diff --git a/docs/plugins/lameinfo_plugin.rst b/docs/plugins/lameinfo_plugin.rst
@@ -34,7 +34,7 @@ Example
 
   $ eyeD3 -P lameinfo test/data/notag-vbr.mp3
 
-  .../home/travis/devel/eyeD3/test/data/notag-vbr.mp3[ 5.98 MB ]
+  .../home/travis/devel/eyeD3/git/test/data/notag-vbr.mp3[ 5.98 MB ]
   -------------------------
   Encoder Version     : LAME3.91
   LAME Tag Revision   : 0

diff --git a/docs/plugins/mimetypes_plugin.rst b/docs/plugins/mimetypes_plugin.rst
@@ -19,10 +19,9 @@ Options
 -------
 .. code-block:: text
 
-    --status           Print dot status.
-    --parse-files      Parse each file.
+    --status         Print dot status.
+    --parse-files    Parse each file.
     --hide-notfound
-    -M, --use-pymagic  Use python-magic to determine mimetype.
 
 
 .. {{{end}}}
diff --git a/eyed3/__about__.py b/eyed3/__about__.py
@@ -14,8 +14,8 @@ def __parse_version(v):                                       # pragma: nocover
     return ver, rel, ver_info
 
 
-__version__ = "0.9.3"
-__release_name__ = "It Dawned On Me"
+__version__ = "0.9.4a0"
+__release_name__ = ""
 __years__ = "2002-2020"
 
 _, __release__, __version_info__ = __parse_version(__version__)

diff --git a/eyed3/__init__.py b/eyed3/__init__.py
@@ -20,7 +20,7 @@
 class Error(Exception):
     """Base exception type for all eyed3 errors."""
     def __init__(self, *args):
-        super(Error, self).__init__(*args)
+        super().__init__(*args)
         if args:
             # The base class will do exactly this if len(args) == 1,
             # but not when > 1. Note, the 2.7 base class will, 3 will not.