new pipeline

Author: adamjakab

.github/workflows/pythonpublish.yml

@@ -0,0 +1,63 @@
+name: Test & Release & Deploy
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python (${{ matrix.python-version }})
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install beets alive-progress
+          pip install pytest nose coverage mock six pyyaml requests
+      - name: Test
+        run: |
+          pytest
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    needs: ["test"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Create Release
+        uses: ncipollo/release-action@v1
+        # ref.: https://github.com/ncipollo/release-action
+        with:
+          name: ${{ github.ref_name }}
+          draft: false
+          generateReleaseNotes: true
+  deploy:
+    name: Deploy
+    runs-on: ubuntu-latest
+    needs: ["release"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+      - name: Build and publish
+        env:
+          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        run: |
+          python -m build
+          twine check dist/*
+          twine upload dist/*

.github/workflows/test_release_deploy.yml

@@ -5,87 +5,87 @@
 
 # Xtractor (Beets Plugin)
 
-The *beets-xtractor* plugin lets you, through the use of the [Essentia](https://essentia.upf.edu/index.html) extractors,
+The _beets-xtractor_ plugin lets you, through the use of the [Essentia](https://essentia.upf.edu/index.html) extractors,
 to obtain low and high level musical information from your songs.
 
 Currently, the following attributes are extracted for each library item:
-`bpm`, `danceability`, `beats_count`, `average_loudness`,  `danceable`, `gender`, `is_male`, `is_female`,
+`bpm`, `danceability`, `beats_count`, `average_loudness`, `danceable`, `gender`, `is_male`, `is_female`,
 `genre_rosamerica`, `voice_instrumental`, `is_voice`, `is_instrumental`, `mood_acoustic`,
 `mood_aggressive`, `mood_electronic`, `mood_happy`, `mood_sad`, `mood_party`, `mood_relaxed`, `mood_mirex`,
 `mood_mirex_cluster_1`, `mood_mirex_cluster_2`, `mood_mirex_cluster_3`, `mood_mirex_cluster_4`, `mood_mirex_cluster_5`
 
 ## Installation
+
 The plugin can be installed via:
 
 ```shell script
-$ pip install beets-xtractor
+pip install beets-xtractor
 ```
+
 and activated the usual way by adding `xtractor` to the list of plugins in your configuration:
 
 ```yaml
 plugins:
-    - xtractor
+  - xtractor
 ```
 
 ### Install the Essentia extractors
 
-You will also need the `streaming_extractor_music` binary extractor from the [Essentia project](#credits). You will need
-to compile this extractor yourself.
-The [official installation documentation](https://essentia.upf.edu/installing.html#compiling-essentia-from-source)
-is somewhat complex but with some cross searching on the internet you will make it. If you are stuck you can use
-the [Issue tracker](https://github.com/adamjakab/BeetsPluginXtractor/issues). Make sure you compile it with Gaia
-support (`--with-gaia`) otherwise will not be able to use the high level models.
-
+You will also need the `streaming_extractor_music` binary extractor from the [Essentia project](#credits).
+Please refer to the [official installation documentation](https://essentia.upf.edu/installing.html#compiling-essentia-from-source)
+for the installation procedure for your OS. If you are stuck you can use
+the [Issue tracker](https://github.com/adamjakab/BeetsPluginXtractor/issues). If you are compiling Essentia from source,
+make sure you compile it with Gaia support (`--with-gaia`) otherwise will not be able to use the high level models.
 
 ### Download the SVM models
 
-The second extractor uses prebuilt trained models for prediction. You need to download these from
-here: [SVM Models](https://essentia.upf.edu/svm_models/). I suggest that you download the more recent beta5 version.
+For computing the high-level descriptors you will need the prebuilt trained models for prediction. You need to download these from
+here: [SVM Models](https://essentia.upf.edu/svm_models/). I suggest that you download the most recent beta5 version.
 This means that your binaries must match this version. Put the downloaded models in any folder from which they can be
 accessed.
 
-
 ## Configuration
+
 All your configuration will need to go under the `xtractor` key. This is what your configuration should look like:
 
 ```yaml
 xtractor:
-    auto: no
-    dry-run: no
-    write: yes
-    threads: 1
-    force: no
-    quiet: no
-    keep_output: yes
-    keep_profiles: no
-    output_path: /mnt/data/xtraction_data
-    essentia_extractor: /mnt/data/extractors/beta5/streaming_extractor_music
-    extractor_profile:
-        highlevel:
-            svm_models:
-                - /mnt/data/extractors/beta5/svm_models/danceability.history
-                - /mnt/data/extractors/beta5/svm_models/gender.history
-                - /mnt/data/extractors/beta5/svm_models/genre_rosamerica.history
-                - /mnt/data/extractors/beta5/svm_models/mood_acoustic.history
-                - /mnt/data/extractors/beta5/svm_models/mood_aggressive.history
-                - /mnt/data/extractors/beta5/svm_models/mood_electronic.history
-                - /mnt/data/extractors/beta5/svm_models/mood_happy.history
-                - /mnt/data/extractors/beta5/svm_models/mood_sad.history
-                - /mnt/data/extractors/beta5/svm_models/mood_party.history
-                - /mnt/data/extractors/beta5/svm_models/mood_relaxed.history
-                - /mnt/data/extractors/beta5/svm_models/voice_instrumental.history
-                - /mnt/data/extractors/beta5/svm_models/moods_mirex.history
+  auto: no
+  dry-run: no
+  write: yes
+  threads: 1
+  force: no
+  quiet: no
+  keep_output: yes
+  keep_profiles: no
+  output_path: /mnt/data/xtraction_data
+  essentia_extractor: /mnt/data/extractors/beta5/streaming_extractor_music
+  extractor_profile:
+    highlevel:
+      svm_models:
+        - /mnt/data/extractors/beta5/svm_models/danceability.history
+        - /mnt/data/extractors/beta5/svm_models/gender.history
+        - /mnt/data/extractors/beta5/svm_models/genre_rosamerica.history
+        - /mnt/data/extractors/beta5/svm_models/mood_acoustic.history
+        - /mnt/data/extractors/beta5/svm_models/mood_aggressive.history
+        - /mnt/data/extractors/beta5/svm_models/mood_electronic.history
+        - /mnt/data/extractors/beta5/svm_models/mood_happy.history
+        - /mnt/data/extractors/beta5/svm_models/mood_sad.history
+        - /mnt/data/extractors/beta5/svm_models/mood_party.history
+        - /mnt/data/extractors/beta5/svm_models/mood_relaxed.history
+        - /mnt/data/extractors/beta5/svm_models/voice_instrumental.history
+        - /mnt/data/extractors/beta5/svm_models/moods_mirex.history
 ```
 
 First of all, you will need adjust all paths. Put the path of the extractor binary in `essentia_extractor` and
 substitute the location of the SVM models with your local path under the `svm_models` section. Finally, set
 the `output_path` to indicate where the extracted data files will be stored. If you do not set this, a temporary path
-will be used. 
+will be used.
 
-**Note on shell tilde expansion**:  Please note that you cannot use shell expansion on the `svm_models` (i.e.: do not use `~` for your home folder).
+**Note on shell tilde expansion**: Please note that you cannot use shell expansion on the `svm_models` (i.e.: do not use `~` for your home folder).
 The entire section of `extractor_profile` is passed as-is to the essentia extractor binary and it will not do tilde expansion on your paths.
 The rest of the path keys such as `essentia_extractor` and `output_path` are used by the plugin itself and it will take
-care of expanding the tilde symbol (`~`) to the home directory of the user running the script. 
+care of expanding the tilde symbol (`~`) to the home directory of the user running the script.
 
 By default both `keep_output` and `keep_profile` options are set to `no`. This means that after extraction (and the
 storage of the important information) the profile files used to pass to the extractors, and the json files created by
@@ -107,22 +107,20 @@ The `dry-run` option shows what would be done without actually doing it.
 
 **NOTE**: Please note that the `auto` option is not yet implemented. For now you will have to call the xtractor plugin manually.
 
-
 ## Usage
 
 Invoke the plugin as:
 
     $ beet xtractor [options] [QUERY...]
-    
+
 For a more verbose reporting use the `-v` flag on `beet`:
 
     $ beet -v xtractor [options] [QUERY...]
-    
+
 The plugin has also got a shorthand `xt` so you can also invoke it like this:
 
     $ beet xt [options] [QUERY...]
 
-
 The following command line options are available:
 
 **--dry-run [-d]**: Only show what would be done - displays the extracted values but does not store them in the library.
@@ -141,14 +139,13 @@ The following command line options are available:
 
 These command line options will override those specified in the configuration file.
 
-
 ## Issues
+
 - If something is not working as expected please use the Issue tracker.
 - If the documentation is not clear please use the Issue tracker.
 - If you have a feature request please use the Issue tracker.
 - In any other situation please use the Issue tracker.
 
-
 ## Other plugins by the same author
 
 - [beets-goingrunning](https://github.com/adamjakab/BeetsPluginGoingRunning)
@@ -159,19 +156,18 @@ These command line options will override those specified in the configuration fi
 - [beets-bpmanalyser](https://github.com/adamjakab/BeetsPluginBpmAnalyser)
 - [beets-template](https://github.com/adamjakab/BeetsPluginTemplate)
 
-
 ## Credits
-Essentia is an open-source C++ library with Python bindings for audio analysis and audio-based music information retrieval. It is released under the Affero GPLv3 license and is also available under proprietary license upon request. This plugin is just a mere wrapper around this library. [Learn more about the Essentia project](http://essentia.upf.edu)
 
+Essentia is an open-source C++ library with Python bindings for audio analysis and audio-based music information retrieval. It is released under the Affero GPLv3 license and is also available under proprietary license upon request. This plugin is just a mere wrapper around this library. [Learn more about the Essentia project](http://essentia.upf.edu)
 
 ## References
+
 - [Essentia](https://essentia.upf.edu/index.html)
 - [SVM Models](https://essentia.upf.edu/svm_models/)
 - [Essentia Licensing](https://essentia.upf.edu/licensing_information.html)
 - [MTG Github - Music Technology Group](https://github.com/MTG)
 - [Acousticbrainz Downloads](https://acousticbrainz.org/download)
 
-
 ## Final Remarks
-Enjoy!
 
+Enjoy!

README.md

@@ -2,21 +2,22 @@
 #  Author: Adam Jakab <adam at jakab dot pro>
 #  License: See LICENSE.txt
 
+from concurrent import futures
 import hashlib
 import json
-import os
 import multiprocessing
-import tempfile
-from concurrent import futures
 from optparse import OptionParser
+import os
 from subprocess import Popen, PIPE
+import tempfile
 
 import yaml
+
 from beets import dbcore
 from beets.library import Library, Item, parse_query_string
 from beets.ui import Subcommand, decargs
-from confuse import Subview
 from beetsplug.xtractor import helper
+from confuse import Subview
 
 
 class XtractorCommand(Subcommand):

beetsplug/xtractor/command.py

@@ -37,16 +37,16 @@
     test_suite='test',
     packages=['beetsplug.xtractor'],
 
-    python_requires='>=3.6',
+    python_requires='>=3.8',
 
     install_requires=[
         'beets>=1.4.9',
-        'PyYAML'
+        'pyyaml'
     ],
 
     tests_require=[
         'pytest', 'nose', 'coverage',
-        'mock', 'six', 'yaml',
+        'mock', 'six', 'pyyaml',
     ],
 
     # Extras needed during testing
@@ -59,8 +59,10 @@
         'License :: OSI Approved :: MIT License',
         'Environment :: Console',
         'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.6',
-        'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
+        'Programming Language :: Python :: 3.12',
     ],
 )