pyrekordbox 0.4.1__tar.gz → 0.4.2__tar.gz

{pyrekordbox-0.4.1 → pyrekordbox-0.4.2}/.github/workflows/tests.yml

@@ -74,7 +74,9 @@ jobs:
         pytest tests/ --cov=pyrekordbox --cov-report=xml -v
 
     - name: Upload coverage to Codecov
-      uses: codecov/codecov-action@v3
+      uses: codecov/codecov-action@v4
+      env:
+        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
       with:
         env_vars: OS,PYTHON
         verbose: True

{pyrekordbox-0.4.1 → pyrekordbox-0.4.2}/.pre-commit-config.yaml

@@ -13,7 +13,7 @@ repos:
           - id: check-yaml
 
     - repo: https://github.com/astral-sh/ruff-pre-commit
-      rev: v0.11.4
+      rev: v0.11.6
       hooks:
         # Run the linter.
         - id: ruff

{pyrekordbox-0.4.1 → pyrekordbox-0.4.2}/CHANGELOG.md

@@ -1,6 +1,22 @@
 # What's New
 
 
+<a name="v0.4.2"></a>
+## [v0.4.2] - 2025-04-21
+
+This release contains bug fixes for the command-line interface and XML handling.
+
+### Improvements/Bug Fixes
+
+- **cli:** **fix import error when downloading db key via CLI ([#162](https://github.com/dylanljones/pyrekordbox/pull/162))**  
+- **xml:** **fix get_track method to accept Location parameter**  
+
+### Documentation
+
+- **anlz:** **add simple tutorial for ANLZ files**  
+- **db:** **add ActiveLoop description**  
+
+
 <a name="v0.4.1"></a>
 ## [v0.4.1] - 2025-04-20
 
@@ -634,7 +650,8 @@ This release contains documentation fixes.
 - **add missing djmd tables to `master.db` database documentation**
 
 
-[Unreleased]: https://github.com/dylanljones/pyrekordbox/compare/v0.4.1...HEAD
+[Unreleased]: https://github.com/dylanljones/pyrekordbox/compare/v0.4.2...HEAD
+[v0.4.2]: https://github.com/dylanljones/pyrekordbox/compare/v0.4.1...v0.4.2
 [v0.4.1]: https://github.com/dylanljones/pyrekordbox/compare/v0.4.0...v0.4.1
 [v0.4.0]: https://github.com/dylanljones/pyrekordbox/compare/v0.3.2...v0.4.0
 [v0.3.2]: https://github.com/dylanljones/pyrekordbox/compare/v0.3.1...v0.3.2

{pyrekordbox-0.4.1/pyrekordbox.egg-info → pyrekordbox-0.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyrekordbox
-Version: 0.4.1
+Version: 0.4.2
 Summary: Inofficial Python package for interacting with the library of Pioneers Rekordbox DJ software.
 Author-email: Dylan Jones <dylanljones94@gmail.com>
 License: MIT License

{pyrekordbox-0.4.1 → pyrekordbox-0.4.2}/docs/source/formats/db6.md

@@ -497,7 +497,7 @@ around 1/75th of a second (13.333ms) per frame, i.e. about half the granularity
      - ?
      -
    * - `ActiveLoop`
-     - ?
+     - Should the loop start active when reaching the point in playback
      -
    * - `Comment`
      - Name of comment of cue point

pyrekordbox-0.4.2/docs/source/tutorial/anlz.md

@@ -0,0 +1,88 @@
+# Analysis Files
+
+Rekordbox stores analysis information of the tracks in the collection in specific files,
+which also get exported to decives used by Pioneer professional DJ equipment. The files
+have names like `ANLZ0000` and come with the extensions `.DAT`, `.EXT` or `.2EX`.
+They include waveforms, beat grids (information about the precise time at which
+each beat occurs), time indices to allow efficient seeking to specific positions
+inside variable bit-rate audio streams, and lists of memory cues and loop points.
+
+```{seealso}
+See the {ref}`Analysis Files Format<Analysis Files Format>` documentation for more information.
+```
+
+## Reading and writing ANLZ Files
+
+To read an ANLZ file, you can use the `AnlzFile.parse_file` method:
+
+```python
+from pyrekordbox import AnlzFile
+
+# Read a single ANLZ file
+anlz = AnlzFile.parse_file("path/to/ANLZXXXX.DAT")
+```
+
+You can also read multiple ANLZ files for a single track using the `read_anlz_files` function.
+It takes the root directory of the files as argument:
+
+```python
+from pyrekordbox import read_anlz_files
+
+# Read all ANLZ files for a track
+files = read_anlz_files("path/to/anlz_directory")
+```
+
+After modifiying the contents of a ANLZ file, it can be saved via
+```python
+# Save the ANLZ file contents
+anlz.save("path/to/ANLZXXXX.DAT")
+```
+
+
+To find the ANLZ files corresponding to a specific track in the Rekordbox collection,
+the database handler includes a method that returnes the directory containing the ANLZ files:
+```python
+>>> from pyrekordbox import Rekordbox6Database
+>>> db = Rekordbox6Database()
+>>> content = db.get_content().first()
+>>> db.get_anlz_dir(content)
+C:\Users\user\AppData\Roaming\Pioneer\rekordbox\share\PIONEER\USBANLZ\0e8\0d4cc-06a6-4574-ba18-1c2301ea9924
+```
+
+Alternatively, a dictionary containing the paths of the ANLZ files can be found via
+```python
+>>> db.get_anlz_paths(content)
+{
+    'DAT': 'C:/Users/user/AppData/Roaming/Pioneer/rekordbox/share/PIONEER/USBANLZ/0e8/0d4cc-06a6-4574-ba18-1c2301ea9924/ANLZ0000.DAT',
+    'EXT': 'C:/Users/user/AppData/Roaming/Pioneer/rekordbox/share/PIONEER/USBANLZ/0e8/0d4cc-06a6-4574-ba18-1c2301ea9924/ANLZ0000.EXT',
+    '2EX': None
+}
+```
+In this example, the analysis data of the track is stored in only two ANLZ files, `ANLZ0000.DAT` and `ANLZ0000.EXT`.
+Instead of returning the paths of the analysis files, they can also be read directly via
+```python
+db.read_anlz_files(content)
+```
+
+
+## Accessing ANLZ Data
+
+The `AnlzFile` object implements a dictionary-like interface. You can access tags by their type code or name:
+
+```python
+# Check if a tag exists
+if "beat_grid" in anlz:
+    print("Beat grid found")
+
+# Get the first tag of a specific type
+beat_grid = anlz.get_tag("PQTZ")
+# or by name
+beat_grid = anlz.get_tag("beat_grid")
+
+# Get all tags of a specific type
+all_cues = anlz.getall_tags("PCOB")
+```
+
+```{note}
+More coming soon!
+```

{pyrekordbox-0.4.1 → pyrekordbox-0.4.2}/docs/source/tutorial/mysetting.md

@@ -13,7 +13,8 @@ DJ equipment.
 See the {ref}`My-Setting Files Format<My-Setting Files Format>` documentation for more information.
 ```
 
-Pyrekordbox includes a file handler for each of the four My-Settings files. To read any of the four files, use
+Pyrekordbox includes a file handler for each of the four My-Settings files.
+To read any of the four files, use
 ````python
 from pyrekordbox import read_mysetting_file
 
@@ -30,6 +31,21 @@ file3 = DjmMySettingFile.parse_file("DJMMYSETTING.DAT")
 file4 = DevSettingFile.parse_file("DEVSETTING.DAT")
 ````
 
+To find the My-Settings files, the database handler includes a method that returnes the
+paths of all four files:
+````python
+>>> from pyrekordbox import Rekordbox6Database
+>>> db = Rekordbox6Database()
+>>> db.get_mysetting_paths()
+[
+    'C:/Users/user/AppData/Roaming/Pioneer/rekordbox/DEVSETTING.DAT',
+    'C:/Users/user/AppData/Roaming/Pioneer/rekordbox/DJMMYSETTING.DAT',
+    'C:/Users/user/AppData/Roaming/Pioneer/rekordbox/MYSETTING.DAT',
+    'C:/Users/user/AppData/Roaming/Pioneer/rekordbox/MYSETTING2.DAT'
+]
+````
+
+
 After parsing a My-Setting file, the settings can be accessed as dictionary:
 ````python
 >>> file = read_mysetting_file("MYSETTING.DAT")

{pyrekordbox-0.4.1 → pyrekordbox-0.4.2}/pyrekordbox/__main__.py

@@ -9,7 +9,7 @@ import sys
 import urllib.request
 from pathlib import Path
 
-from pyrekordbox.config import _cache_file, write_db6_key_cache
+from pyrekordbox.config import get_cache_file, write_db6_key_cache
 
 KEY_SOURCES = [
     {
@@ -144,7 +144,8 @@ def download_db6_key():
             dp = match.group("dp")
             break
     if dp:
-        print(f"Found key, updating cache file {_cache_file}")
+        cache_file = get_cache_file()
+        print(f"Found key, updating cache file {cache_file}")
         write_db6_key_cache(dp)
     else:
         print("No key found in the online sources.")

{pyrekordbox-0.4.1 → pyrekordbox-0.4.2}/pyrekordbox/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.4.1'
-__version_tuple__ = version_tuple = (0, 4, 1)
+__version__ = version = '0.4.2'
+__version_tuple__ = version_tuple = (0, 4, 2)

{pyrekordbox-0.4.1 → pyrekordbox-0.4.2}/pyrekordbox/config.py

@@ -67,6 +67,10 @@ def get_appdata_dir() -> Path:
     return app_data
 
 
+def get_cache_file() -> Path:
+    return get_appdata_dir() / "pyrekordbox" / _cache_file_name
+
+
 def get_pioneer_install_dir(path: Union[str, Path] = None) -> Path:  # pragma: no cover
     """Returns the path of the Pioneer program installation directory.
 
@@ -477,7 +481,7 @@ def write_db6_key_cache(key: str) -> None:  # pragma: no cover
     lines.append("dp: " + key)
     text = "\n".join(lines)
 
-    cache_file = get_appdata_dir() / "pyrekordbox" / _cache_file_name
+    cache_file = get_cache_file()
     if not cache_file.parent.exists():
         cache_file.parent.mkdir()
 
@@ -494,7 +498,7 @@ def _update_sqlite_key(opts, conf):
     cache_version = 0
     pw, dp = "", ""
 
-    cache_file = get_appdata_dir() / "pyrekordbox" / _cache_file_name
+    cache_file = get_cache_file()
 
     if cache_file.exists():  # pragma: no cover
         logger.debug("Found cache file %s", cache_file)

{pyrekordbox-0.4.1 → pyrekordbox-0.4.2}/pyrekordbox/db6/database.py

@@ -27,7 +27,7 @@ try:
     from sqlcipher3 import dbapi2 as sqlite3  # noqa
 
     _sqlcipher_available = True
-except ImportError:
+except ImportError:  # pragma: no cover
     import sqlite3
 
     _sqlcipher_available = False
@@ -125,9 +125,9 @@ class Rekordbox6Database:
             raise FileNotFoundError(f"File '{path}' does not exist!")
         # Open database
         if unlock:
-            if not _sqlcipher_available:
+            if not _sqlcipher_available:  # pragma: no cover
                 raise ImportError("Could not unlock database: 'sqlcipher3' package not found")
-            if not key:
+            if not key:  # pragma: no cover
                 try:
                     key = rb_config["dp"]
                 except KeyError:

{pyrekordbox-0.4.1 → pyrekordbox-0.4.2}/pyrekordbox/db6/tables.py

@@ -207,14 +207,14 @@ class Base(DeclarativeBase):
         return [column.key for column in inspect(cls).relationships]  # noqa
 
     @classmethod
-    def __get_keys__(cls):
+    def __get_keys__(cls):  # pragma: no cover
         """Get all attributes of the table."""
         items = cls.__dict__.items()
         keys = [k for k, v in items if not callable(v) and not k.startswith("_")]
         return keys
 
     @classmethod
-    def keys(cls):
+    def keys(cls):  # pragma: no cover
         """Returns a list of all column names including the relationships."""
         if not cls.__keys__:  # Cache the keys
             cls.__keys__ = cls.__get_keys__()
@@ -248,7 +248,7 @@ class Base(DeclarativeBase):
         """Returns a dictionary of all column names and values."""
         return {key: self.__getitem__(key) for key in self.columns()}
 
-    def pformat(self, indent="   "):
+    def pformat(self, indent="   "):  # pragma: no cover
         lines = [f"{self.__tablename__}"]
         columns = self.columns()
         w = max(len(col) for col in columns)

{pyrekordbox-0.4.1 → pyrekordbox-0.4.2}/pyrekordbox/rbxml.py

@@ -1042,13 +1042,14 @@ class RekordboxXml:
         >>> track = file.get_track(TrackID=1)
 
         """
-        if index is None and TrackID is None:
-            raise ValueError("Either index or TrackID has to be specified!")
+        if index is None and TrackID is None and Location is None:
+            raise ValueError("Either index, TrackID or Location has to be specified!")
 
         if TrackID is not None:
             el = self._collection.find(f'.//{Track.TAG}[@TrackID="{TrackID}"]')
         elif Location is not None:
-            el = self._collection.find(f'.//{Track.TAG}[@Location="{Location}"]')
+            encoded = encode_path(Location)
+            el = self._collection.find(f'.//{Track.TAG}[@Location="{encoded}"]')
         else:
             el = self._collection.find(f".//{Track.TAG}[{index + 1}]")
         return Track(element=el)
@@ -1091,10 +1092,10 @@ class RekordboxXml:
             node = node.get_playlist(name)
         return node
 
-    def _update_track_count(self):
-        """Updates the track count element."""
-        num_tracks = len(self._collection.findall(f".//{Track.TAG}"))
-        self._collection.attrib["Entries"] = str(num_tracks)
+    # def _update_track_count(self):
+    #     """Updates the track count element."""
+    #     num_tracks = len(self._collection.findall(f".//{Track.TAG}"))
+    #     self._collection.attrib["Entries"] = str(num_tracks)
 
     def _increment_track_count(self):
         """Increment the track count element."""

{pyrekordbox-0.4.1 → pyrekordbox-0.4.2/pyrekordbox.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyrekordbox
-Version: 0.4.1
+Version: 0.4.2
 Summary: Inofficial Python package for interacting with the library of Pioneers Rekordbox DJ software.
 Author-email: Dylan Jones <dylanljones94@gmail.com>
 License: MIT License

{pyrekordbox-0.4.1 → pyrekordbox-0.4.2}/pyrekordbox.egg-info/SOURCES.txt

@@ -13,6 +13,7 @@ requirements.txt
 .github/workflows/codeql.yml
 .github/workflows/pypi-publish.yml
 .github/workflows/tests.yml
+.testdata/empty.mp3
 .testdata/export/PIONEER/DEVSETTING.DAT
 .testdata/export/PIONEER/DJMMYSETTING.DAT
 .testdata/export/PIONEER/MYSETTING.DAT
@@ -323,6 +324,7 @@ pyrekordbox/mysettings/file.py
 pyrekordbox/mysettings/structs.py
 tests/__init__.py
 tests/test_anlz.py
+tests/test_cli.py
 tests/test_config.py
 tests/test_db6.py
 tests/test_mysetting.py

pyrekordbox-0.4.2/tests/test_cli.py

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+# Author: Dylan Jones
+# Date:   2025-04-21
+
+from subprocess import run
+from types import SimpleNamespace as Namespace
+
+
+def shell(command, **kwargs):
+    """Execute a shell command capturing output and exit code."""
+    completed = run(command, shell=True, capture_output=True, check=False, **kwargs)
+    return Namespace(
+        exit_code=completed.returncode,
+        stdout=completed.stdout.decode(),
+        stderr=completed.stderr.decode(),
+    )
+
+
+def test_cli():
+    """Check if the CLI is callable."""
+    result = shell("python -m pyrekordbox --help")
+    # Check if the command was successful
+    assert result.exit_code == 0, f"Command failed with exit code {result.exit_code}"
+
+
+def test_download_key():
+    """Test the download-key command."""
+    result = shell("python -m pyrekordbox download-key")
+    # Check if the command was successful
+    assert result.exit_code == 0, f"Command failed with exit code {result.exit_code}"
+    assert "Found key, updating cache file" in result.stdout

{pyrekordbox-0.4.1 → pyrekordbox-0.4.2}/tests/test_db6.py

@@ -1222,6 +1222,18 @@ def test_add_label(db):
         db.add_label(name)
 
 
+def test_add_content(db):
+    path = os.path.join(TEST_ROOT, "empty.mp3")
+    # Add content
+    content = db.add_content(path, Title="Test")
+    assert content.Title == "Test"
+    assert content.FolderPath == path
+
+    # Fail on duplicate content
+    with pytest.raises(ValueError):
+        db.add_content(path)
+
+
 def test_get_anlz_paths():
     content = DB.get_content().first()
 

{pyrekordbox-0.4.1 → pyrekordbox-0.4.2}/tests/test_xml.py

@@ -7,7 +7,7 @@ import os
 import pytest
 
 from pyrekordbox import RekordboxXml
-from pyrekordbox.rbxml import PositionMark, Tempo, XmlDuplicateError
+from pyrekordbox.rbxml import Node, PositionMark, Tempo, XmlDuplicateError
 
 TEST_ROOT = os.path.join(os.path.dirname(os.path.dirname(__file__)), ".testdata")
 XML5 = os.path.join(TEST_ROOT, "rekordbox 5", "database.xml")
@@ -548,9 +548,39 @@ def test_add_position_mark():
     assert mark.Num == num
 
 
+def test_get_track():
+    xml = RekordboxXml(XML6)
+
+    with pytest.raises(ValueError):
+        # Nothing provided
+        xml.get_track()
+
+    idx = 0
+    expected_loc = os.path.normpath(r"C:/Music/PioneerDJ/Demo Tracks/Demo Track 1.mp3")
+    expected_id = 253529738
+
+    # Test getting by index
+    track = xml.get_track(index=idx)
+    assert track.Location == expected_loc
+    assert track.TrackID == expected_id
+
+    # Test getting by TrackID
+    track = xml.get_track(TrackID=expected_id)
+    assert track.Location == expected_loc
+    assert track.TrackID == expected_id
+
+    # Test getting by Location
+    track = xml.get_track(Location=expected_loc)
+    assert track.Location == expected_loc
+    assert track.TrackID == expected_id
+
+
 def test_get_playlist():
     xml = RekordboxXml(XML5)
 
+    playlists = xml.get_playlist()
+    assert isinstance(playlists, Node)
+
     playlist = xml.get_playlist("Playlist1")
     assert playlist.is_playlist
     assert not playlist.is_folder
@@ -559,6 +589,10 @@ def test_get_playlist():
     assert folder.is_folder
     assert not folder.is_playlist
 
+    sub_playlists = folder.get_playlists()
+    assert isinstance(sub_playlists, list)
+    assert len(sub_playlists) == 1
+
     sub_playlist = xml.get_playlist("Folder", "Sub Playlist")
     assert sub_playlist.is_playlist
     assert not sub_playlist.is_folder
@@ -620,6 +654,7 @@ def test_update_playlist_entries():
 
     playlist.add_track(0)
     assert playlist.entries == 1
+    assert playlist.get_track(0) == 0
 
     playlist.add_track(1)
     assert playlist.entries == 2
@@ -629,3 +664,26 @@ def test_update_playlist_entries():
 
     playlist.remove_track(0)
     assert playlist.entries == 0
+
+
+def test_playlist_treestr():
+    xml = RekordboxXml(XML5)
+    root = xml.get_playlist()
+    assert isinstance(root.treestr(), str)
+
+    playlist = xml.get_playlist("Playlist1")
+    assert isinstance(playlist.treestr(), str)
+
+
+def test_save_load(tmp_path):
+    xml = RekordboxXml(XML5)
+
+    # Save to a file
+    test_file = tmp_path / "test_save_reload.xml"
+    xml.save(test_file)
+
+    # Load the saved file
+    loaded = RekordboxXml(test_file)
+
+    # Verify content was preserved
+    assert loaded.num_tracks == xml.num_tracks

pyrekordbox-0.4.1/docs/source/tutorial/anlz.md

@@ -1,7 +0,0 @@
-# Analysis Files
-
-Coming soon!
-
-```{seealso}
-See the {ref}`Analysis Files Format<Analysis Files Format>` documentation for more information.
-```