Merge branch 'release/0.7.3'

.github/config.yml

@@ -0,0 +1,19 @@
+# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome
+
+# Comment to be posted to on first time issues
+newIssueWelcomeComment: |
+ 👋 Thanks for opening your first issue here! If you're reporting a 🐞 bug, please make sure you include steps to reproduce it. We get a lot of issues on this repo, so please be patient and we will get back to you as soon as we can.
+
+ To help make it easier for us to investigate your issue, please follow the [contributing instructions](https://github.com/whipper-team/whipper#bug-reports--feature-requests).
+
+# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome
+
+# Comment to be posted to on PRs from first time contributors in your repository
+newPRWelcomeComment: >
+ 💖 Thanks for opening your first pull request here! 💖
+
+# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
+
+# Comment to be posted to on pull requests merged by a first time user
+firstPRMergeComment: >
+ Congrats on merging your first pull request! 🎉🎉🎉

.github/stale.yml

@@ -0,0 +1,42 @@
+# Configuration for probot-stale - https://github.com/probot/stale
+
+# Number of days of inactivity before an Issue or Pull Request becomes stale
+daysUntilStale: 30
+
+# Number of days of inactivity before an Issue or Pull Request with the stale label is closed.
+# Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale.
+daysUntilClose: 7
+
+# Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable
+exemptLabels:
+ - Accepted
+
+# Set to true to ignore issues in a project (defaults to false)
+exemptProjects: false
+
+# Set to true to ignore issues in a milestone (defaults to false)
+exemptMilestones:
+ - "2.0"
+ - backlog
+
+# Label to use when marking as stale
+staleLabel: "Status: stale"
+
+# Comment to post when marking as stale. Set to `false` to disable
+markComment: >
+ This issue/pull request has been automatically marked as stale because it has not had
+ recent activity. It will be closed in 7 days if no further activity occurs. Thank you
+ for your contributions.
+
+# Comment to post when removing the stale label.
+unmarkComment: >
+ Thank you for updating this issue. It is no longer marked as stale.
+
+# Comment to post when closing a stale Issue or Pull Request.
+closeComment: |
+ This issue/pull request has been closed due to prolonged inactivity.
+
+ If you think this is an error, please leave a comment and we will gladly reopen it.
+
+# Limit the number of actions per hour, from 1-30. Default is 30
+limitPerRun: 30

COVERAGE

@@ -1,4 +1,4 @@
-Coverage.py 4.5.1 text report against whipper v0.7.2
+Coverage.py 4.5.2 text report against whipper v0.7.3
 
 $ coverage run --branch --omit='whipper/test/*' --source=whipper -m unittest discover
 $ coverage report -m
@@ -8,42 +8,42 @@ Name Stmts Miss Branch BrPart Cover Missing
 whipper/__init__.py 10 2 4 2 71% 9, 11, 8->9, 10->11
 whipper/__main__.py 7 7 2 0 0% 4-14
 whipper/command/__init__.py 0 0 0 0 100%
-whipper/command/accurip.py 44 44 18 0 0% 21-96
+whipper/command/accurip.py 43 43 18 0 0% 21-92
 whipper/command/basecommand.py 69 53 30 0 16% 56-114, 121-130, 133, 136, 139, 142-145
-whipper/command/cd.py 219 181 56 0 14% 71-79, 84-184, 187, 199, 222-276, 283-308, 311-488
-whipper/command/drive.py 62 62 12 0 0% 21-122
+whipper/command/cd.py 224 186 58 0 13% 71-79, 84-193, 196, 208, 231-284, 291-318, 321-491
+whipper/command/drive.py 57 57 10 0 0% 21-107
 whipper/command/image.py 38 38 6 0 0% 21-76
-whipper/command/main.py 65 65 20 0 0% 4-109
+whipper/command/main.py 68 68 22 0 0% 4-115
 whipper/command/mblookup.py 28 28 8 0 0% 1-41
-whipper/command/offset.py 111 111 32 0 0% 21-227
+whipper/command/offset.py 110 110 32 0 0% 21-221
 whipper/common/__init__.py 0 0 0 0 100%
-whipper/common/accurip.py 133 5 54 5 95% 123, 134, 143-145, 116->123, 127->134, 160->163, 252->258, 261->267
-whipper/common/cache.py 105 50 34 6 44% 66-90, 96, 99, 107-112, 115-116, 132, 144-149, 172-179, 203-208, 213-230, 95->96, 98->99, 131->132, 142->153, 143->144, 171->172
+whipper/common/accurip.py 133 5 54 5 95% 121, 130, 139-141, 116->121, 125->130, 155->158, 246->252, 255->261
+whipper/common/cache.py 105 50 34 6 44% 66-90, 96, 99, 107-112, 115-116, 132, 144-148, 171-178, 202-207, 212-228, 95->96, 98->99, 131->132, 142->152, 143->144, 170->171
 whipper/common/checksum.py 26 14 2 0 43% 41-42, 45-46, 49-64
-whipper/common/common.py 142 22 32 6 83% 50-51, 118-119, 142-143, 161-168, 180, 274-280, 316-320, 117->118, 130->133, 179->180, 189->196, 270->274, 314->322
-whipper/common/config.py 92 8 18 4 89% 105-106, 124-125, 131, 142, 144, 146, 130->131, 141->142, 143->144, 145->146
+whipper/common/common.py 150 28 38 6 78% 51-52, 119-120, 143-144, 162-169, 181, 275-280, 287-292, 329-333, 118->119, 131->134, 180->181, 190->197, 271->275, 327->335
+whipper/common/config.py 92 8 18 4 89% 105-106, 124-125, 131, 141, 143, 145, 130->131, 140->141, 142->143, 144->145
 whipper/common/directory.py 21 8 10 2 55% 29, 39, 44-51, 28->29, 38->39
 whipper/common/drive.py 31 20 6 0 35% 35-40, 44-50, 54-60, 64-71
 whipper/common/encode.py 44 23 2 0 46% 37-38, 41-42, 45-46, 53-56, 59-60, 63-64, 76-77, 80-81, 84-91
-whipper/common/mbngs.py 159 53 58 7 66% 38-39, 45, 90-96, 158-159, 164-165, 209, 212, 215, 238-241, 250, 270-324, 157->158, 163->164, 208->209, 211->212, 214->215, 237->238, 247->250
+whipper/common/mbngs.py 159 53 58 7 66% 38-39, 45, 90-96, 157-158, 163-164, 208, 211, 214, 237-239, 248, 268-322, 156->157, 162->163, 207->208, 210->211, 213->214, 236->237, 245->248
 whipper/common/path.py 24 0 8 3 91% 42->45, 52->57, 62->67
-whipper/common/program.py 344 263 108 5 20% 89-91, 97-105, 113-145, 154-159, 162, 166-170, 215, 226-227, 229-233, 249-264, 272-398, 409-459, 467-475, 478-494, 505-545, 557-574, 577-595, 598-608, 611-619, 81->84, 212->215, 225->226, 228->229, 235->239
+whipper/common/program.py 337 259 110 5 20% 85-87, 93-100, 109-141, 150-155, 158, 162-166, 211, 222-223, 225-229, 245-260, 268-380, 391-442, 450-458, 461-476, 487-527, 539-556, 559-577, 580-590, 593-601, 77->80, 208->211, 221->222, 224->225, 231->235
 whipper/common/renamer.py 102 2 16 1 97% 135, 158, 60->68
-whipper/common/task.py 77 19 14 2 75% 47-52, 87-88, 91-94, 102, 116-117, 124, 130, 136, 142, 148, 85->87, 99->102
+whipper/common/task.py 77 19 14 2 75% 47-52, 86-87, 90-93, 101, 114-115, 122, 128, 134, 140, 146, 84->86, 98->101
 whipper/extern/__init__.py 0 0 0 0 100%
 whipper/extern/asyncsub.py 130 71 66 12 40% 15-17, 32, 37-38, 47-84, 89-102, 115, 122, 134, 145, 151, 156-160, 164-176, 14->15, 35->37, 45->47, 110->113, 114->115, 121->122, 133->134, 139->141, 141->152, 144->145, 148->151, 163->164
 whipper/extern/freedb.py 104 83 38 1 17% 49, 57-58, 61, 64, 84-162, 170-222, 56->57
 whipper/extern/task/__init__.py 0 0 0 0 100%
-whipper/extern/task/task.py 276 117 54 11 53% 26-27, 56, 60, 86, 152-154, 172-174, 182-198, 216-219, 239-240, 281-282, 285-291, 306-307, 315-317, 326-333, 339-355, 359, 362, 369-386, 397-398, 401-404, 408, 411, 426, 429-431, 447, 459, 504-509, 518-523, 534-542, 545-553, 556-557, 565, 570-572, 55->56, 59->60, 68->70, 151->152, 165->exit, 215->216, 229->231, 234->exit, 494->496, 531->534, 569->570
+whipper/extern/task/task.py 277 116 54 11 54% 57, 61, 81, 87, 153-155, 174-176, 184-200, 218-221, 241-242, 283-284, 287-293, 308-309, 317-319, 328-335, 341-357, 361, 364, 371-388, 399-400, 403-406, 410, 413, 428, 431-433, 449, 461, 506-511, 520-525, 536-544, 547-555, 558-559, 567, 572-574, 56->57, 60->61, 69->71, 152->153, 166->exit, 217->218, 231->233, 236->exit, 496->498, 533->536, 571->572
 whipper/image/__init__.py 0 0 0 0 100%
 whipper/image/cue.py 91 9 20 3 89% 99, 116-117, 132-134, 159, 187, 205, 98->99, 115->116, 131->132
-whipper/image/image.py 117 94 18 0 17% 49-57, 65-67, 74-107, 121-153, 156-172, 183-214
-whipper/image/table.py 398 22 114 16 93% 237, 346-347, 499, 578, 664-665, 685-686, 695-698, 702-703, 750, 796-797, 799-800, 844-845, 850-852, 180->183, 498->499, 532->536, 555->558, 577->578, 585->592, 684->685, 693->699, 694->695, 723->728, 728->722, 749->750, 795->796, 798->799, 843->844, 849->850
-whipper/image/toc.py 203 15 60 10 90% 134, 262-263, 279-282, 340-342, 364-366, 386, 410, 130->134, 213->221, 261->262, 278->279, 288->293, 324->331, 339->340, 363->364, 373->377, 405->410
+whipper/image/image.py 117 94 18 0 17% 49-57, 65-67, 74-107, 121-153, 156-172, 183-213
+whipper/image/table.py 398 22 114 16 93% 237, 346-347, 499, 578, 663-664, 684-685, 694-697, 701-702, 747, 793-794, 796-797, 841-842, 847-849, 180->183, 498->499, 532->536, 555->558, 577->578, 585->592, 683->684, 692->698, 693->694, 722->726, 726->721, 746->747, 792->793, 795->796, 840->841, 846->847
+whipper/image/toc.py 203 16 60 10 90% 134, 261-262, 278-281, 339-341, 363-365, 385, 409, 439, 130->134, 212->220, 260->261, 277->278, 287->292, 323->330, 338->339, 362->363, 372->376, 404->409
 whipper/program/__init__.py 0 0 0 0 100%
-whipper/program/arc.py 38 15 12 4 58% 26-28, 32, 37-43, 52-58, 22->26, 31->32, 36->37, 45->52
-whipper/program/cdparanoia.py 315 185 86 3 39% 48-50, 59-60, 124-126, 163-166, 199-200, 241-255, 258-310, 313-351, 354-358, 361-397, 452-504, 509-554, 587-590, 593, 600, 606, 611-616, 123->124, 599->600, 603->606
-whipper/program/cdrdao.py 51 29 10 2 39% 25-47, 54-60, 70-72, 76-78, 86, 93, 69->70, 75->76
+whipper/program/arc.py 38 15 12 4 58% 26-28, 32, 37-41, 48-54, 22->26, 31->32, 36->37, 43->48
+whipper/program/cdparanoia.py 315 185 86 3 39% 48-50, 59-60, 124-126, 163-166, 199-200, 242-256, 259-310, 313-351, 354-358, 361-397, 452-504, 509-554, 587-590, 593, 600, 606, 611-616, 123->124, 599->600, 603->606
+whipper/program/cdrdao.py 59 36 14 2 34% 26-56, 63-69, 79-81, 85-87, 95, 102, 78->79, 84->85
 whipper/program/flac.py 9 5 0 0 44% 12-19
 whipper/program/sox.py 17 4 4 2 71% 18-19, 23-24, 17->18, 22->23
 whipper/program/soxi.py 28 2 2 1 90% 36, 49, 48->49
@@ -52,4 +52,4 @@ whipper/result/__init__.py 0 0 0 0 100%
 whipper/result/logger.py 148 148 48 0 0% 1-242
 whipper/result/result.py 56 13 6 0 69% 112-116, 134, 144-145, 154-161
 -----------------------------------------------------------------------------
-TOTAL 3950 1900 1090 108 49%
+TOTAL 3961 1910 1104 108 49%

Dockerfile

@@ -9,7 +9,7 @@ RUN apt-get update \
  && pip install pycdio==2.0.0
 
 # libcdio-paranoia / libcdio-utils are wrongfully packaged in Debian, thus built manually
-# see https://github.com/JoeLametta/whipper/pull/237#issuecomment-367985625
+# see https://github.com/whipper-team/whipper/pull/237#issuecomment-367985625
 RUN curl -o - 'https://ftp.gnu.org/gnu/libcdio/libcdio-2.0.0.tar.gz' | tar zxf - \
  && cd libcdio-2.0.0 \
  && autoreconf -fi \

README.md

@@ -117,7 +117,8 @@ If you are building from a source tarball or checkout, you can choose to use whi
 Whipper relies on the following packages in order to run correctly and provide all the supported features:
 
 - [cd-paranoia](https://www.gnu.org/software/libcdio/), for the actual ripping
- - To avoid bugs it's advised to use `cd-paranoia` **10.2+0.94+2-2**
+ - To avoid bugs it's advised to use `cd-paranoia` version **10.2+0.94+2-2**
+ - The package named `libcdio-utils`, available on Debian and Ubuntu, is affected by a bug: it doesn't include the `cd-paranoia` binary (needed by whipper). For more details see: [#888053 (Debian)](https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=888053), [#1750264 (Ubuntu)](https://bugs.launchpad.net/ubuntu/+source/libcdio/+bug/1750264).
 - [cdrdao](http://cdrdao.sourceforge.net/), for session, TOC, pre-gap, and ISRC extraction
 - [GObject Introspection](https://wiki.gnome.org/Projects/GObjectIntrospection), to provide GLib-2.0 methods used by `task.py`
 - [PyGObject](https://pypi.org/project/PyGObject/), required by `task.py`
@@ -126,7 +127,7 @@ Whipper relies on the following packages in order to run correctly and provide a
 - [python-setuptools](https://pypi.python.org/pypi/setuptools), for installation, plugins support
 - [python-requests](https://pypi.python.org/pypi/requests), for retrieving AccurateRip database entries
 - [pycdio](https://pypi.python.org/pypi/pycdio/), for drive identification (required for drive offset and caching behavior to be stored in the configuration file).
- - To avoid bugs it's advised to use `pycdio` **0.20** or **0.21** with `libcdio` ≥ **0.90** ≤ **0.94**. If using `libcdio` **0.83**, which is _too old_ to satisfy all the requirements of whipper, just stick to `pycdio` **0.17**. Altough it needs additional testing, `libcdio` **2.0.0** seems to work fine if used with `pycdio` **2.0.0**. All other combinations aren't guaranteed to work.
+ - To avoid bugs it's advised to use `pycdio` **0.20** or **0.21** with `libcdio` ≥ **0.90** ≤ **0.94* or `pycdio` **2.0.0** with `libcdio` **2.0.0**. All other combinations won't probably work.
 - [libsndfile](http://www.mega-nerd.com/libsndfile/), for reading wav files
 - [flac](https://xiph.org/flac/), for reading flac files
 - [sox](http://sox.sourceforge.net/), for track peak detection
@@ -250,7 +251,7 @@ read_offset = 6 ; drive read offset in positive/negative frames (no leading +)
 unknown = True
 output_directory = ~/My Music
 track_template = new/%%A/%%y - %%d/%%t - %%n ; note: the format char '%' must be represented '%%'
-disc_template = %(track_template)s
+disc_template =  new/%%A/%%y - %%d/%%A - %%d
 # ...
 ```
 
@@ -265,14 +266,31 @@ python2 -m whipper -h
 
 ## Logger plugins
 
-Whipper supports using external logger plugins to write rip `.log` files.
+Whipper allows using external logger plugins to customize the template of `.log` files.
 
-List available plugins with `whipper cd rip -h`. Specify a logger to rip with by passing `-L loggername`:
+The available plugins can be listed with `whipper cd rip -h`. Specify a logger to rip with by passing `-L loggername`:
 
 ```bash
-whipper cd rip -L what
+whipper cd rip -L eac
 ```
 
+Whipper searches for logger plugins in the following paths:
+
+- `$XDG_DATA_HOME/whipper/plugins`
+- Paths returned by the following Python instruction:
+
+ `[x + '/whipper/plugins' for x in site.getsitepackages()]`
+
+- If whipper is run in a `virtualenv`, it will use these alternative instructions (from `distutils.sysconfig`):
+ - `get_python_lib(plat_specific=False, standard_lib=False, prefix='/usr/local') + '/whipper/plugins'`
+ - `get_python_lib(plat_specific=False, standard_lib=False) + '/whipper/plugins'`
+
+On a default Debian/Ubuntu installation, the following paths are searched by whipper:
+
+- `$HOME/.local/share/whipper/plugins`
+- `/usr/local/lib/python2.7/dist-packages/whipper/plugins`
+- `/usr/lib/python2.7/dist-packages/whipper/plugins`
+
 ### Official logger plugins
 
 I suggest using whipper's default logger unless you've got particular requirements.

TODO

@@ -1,6 +1,6 @@
 TODO:
 
-Please see https://github.com/JoeLametta/whipper/milestones for further
+Please see https://github.com/whipper-team/whipper/milestones for further
 TODO items; this file exists only to have contents individually removed
 eventually, not to be continually updated.
 

setup.py

@@ -5,9 +5,9 @@
  name="whipper",
  version=whipper_version,
  description="a secure cd ripper preferring accuracy over speed",
- author=['Thomas Vander Stichele', 'Joe Lametta', 'Samantha Baldwin'],
- maintainer=['Joe Lametta', 'Samantha Baldwin'],
- url='https://github.com/JoeLametta/whipper',
+ author=['Thomas Vander Stichele', 'The Whipper Team'],
+ maintainer=['The Whipper Team'],
+ url='https://github.com/whipper-team/whipper',
  license='GPL3',
  packages=find_packages(),
  entry_points={

whipper/__init__.py

@@ -2,9 +2,9 @@
 import os
 import sys
 
-__version__ = '0.7.2'
+__version__ = '0.7.3'
 
-level = logging.WARNING
+level = logging.INFO
 if 'WHIPPER_DEBUG' in os.environ:
  level = os.environ['WHIPPER_DEBUG'].upper()
 if 'WHIPPER_LOGFILE' in os.environ:

whipper/command/accurip.py

@@ -18,8 +18,6 @@
 # You should have received a copy of the GNU General Public License
 # along with whipper. If not, see <http://www.gnu.org/licenses/>.
 
-import sys
-
 from whipper.command.basecommand import BaseCommand
 from whipper.common.accurip import get_db_entry, ACCURATERIP_URL
 
@@ -42,18 +40,16 @@ def do(self):
 
  count = responses[0].num_tracks
 
- sys.stdout.write("Found %d responses for %d tracks\n\n" % (
- len(responses), count))
+ logger.info("found %d responses for %d tracks", len(responses), count)
 
  for (i, r) in enumerate(responses):
  if r.num_tracks != count:
- sys.stdout.write(
- "Warning: response %d has %d tracks instead of %d\n" % (
- i, r.num_tracks, count))
+ logger.warning("response %d has %d tracks instead of %d",
+ i, r.num_tracks, count)
 
  # checksum and confidence by track
  for track in range(count):
- sys.stdout.write("Track %d:\n" % (track + 1))
+ print("Track %d:" % (track + 1))
  checksums = {}
 
  for (i, r) in enumerate(responses):
@@ -82,9 +78,9 @@ def do(self):
  sortedChecksums.reverse()
 
  for highest, checksum in sortedChecksums:
- sys.stdout.write(" %d result(s) for checksum %s: %s\n" % (
- len(checksums[checksum]), checksum,
- str(checksums[checksum])))
+ print(" %d result(s) for checksum %s: %s" % (
+  len(checksums[checksum]),
+  checksum, checksums[checksum]))
 
 
 class AccuRip(BaseCommand):