pyrekordbox 0.4.3__tar.gz → 0.4.4__tar.gz

pyrekordbox-0.4.4/.github/FUNDING.yml

@@ -0,0 +1 @@
+buy_me_a_coffee: dylanljones

{pyrekordbox-0.4.3 → pyrekordbox-0.4.4}/.pre-commit-config.yaml

@@ -3,7 +3,7 @@
 
 repos:
     - repo: https://github.com/pre-commit/pre-commit-hooks
-      rev: v5.0.0
+      rev: v6.0.0
       hooks:
           - id: end-of-file-fixer
           - id: trailing-whitespace
@@ -13,7 +13,7 @@ repos:
           - id: check-yaml
 
     - repo: https://github.com/astral-sh/ruff-pre-commit
-      rev: v0.11.9
+      rev: v0.12.8
       hooks:
         # Run the linter.
         - id: ruff

{pyrekordbox-0.4.3 → pyrekordbox-0.4.4}/CHANGELOG.md

@@ -1,5 +1,26 @@
 # What's New
 
+
+<a name="v0.4.4"></a>
+## [v0.4.4] - 2025-08-17
+
+This update strengthens database key management, optimizes datetime parsing for consistent timezone 
+handling, and improves PSSI tag processing to better detect and deobfuscate garbled ANLZ files.
+
+### Improvements/Bug Fixes
+
+- **db:** **improve database key handling ([#181](https://github.com/dylanljones/pyrekordbox/issues/181))**  
+  The database handling is now much more robust. This also improves the config performance of the 
+  library and reduces the number of dependencies. The 'download_key' CLI command was removed as well.
+  Note: The app-data directory of pyrekordbox can be removed as it is no longer used.
+- **db:** **enhance datetime parsing for timezone handling ([#176](https://github.com/dylanljones/pyrekordbox/pull/176))**  
+  Updated the string_to_datetime function to normalize 'Z' to '+00:00' and improved handling of 
+  timezone information. This ensures compatibility with various datetime formats and maintains 
+  consistency with UTC representation.
+- **anlz**: **enhance PSSI tag handling to improve garbled file detection and deobfuscation ([#175](https://github.com/dylanljones/pyrekordbox/pull/175))**  
+  Updated logic for mood and bank validation, and refined XOR deobfuscation process for garbled tags.
+
+
 <a name="v0.4.3"></a>
 ## [v0.4.3] - 2025-05-14
 
@@ -666,7 +687,8 @@ This release contains documentation fixes.
 - **add missing djmd tables to `master.db` database documentation**
 
 
-[Unreleased]: https://github.com/dylanljones/pyrekordbox/compare/v0.4.3...HEAD
+[Unreleased]: https://github.com/dylanljones/pyrekordbox/compare/v0.4.4...HEAD
+[v0.4.4]: https://github.com/dylanljones/pyrekordbox/compare/v0.4.3...v0.4.4
 [v0.4.3]: https://github.com/dylanljones/pyrekordbox/compare/v0.4.2...v0.4.3
 [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

{pyrekordbox-0.4.3 → pyrekordbox-0.4.4}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022-2024, Dylan Jones
+Copyright (c) 2022-2025, Dylan Jones
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{pyrekordbox-0.4.3 → pyrekordbox-0.4.4}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: pyrekordbox
-Version: 0.4.3
+Version: 0.4.4
 Summary: Inofficial Python package for interacting with the library of Pioneers Rekordbox DJ software.
 Author-email: Dylan Jones <dylanljones94@gmail.com>
 License: MIT License
         
-        Copyright (c) 2022-2024, Dylan Jones
+        Copyright (c) 2022-2025, Dylan Jones
         
         Permission is hereby granted, free of charge, to any person obtaining a copy
         of this software and associated documentation files (the "Software"), to deal
@@ -29,7 +29,7 @@ Project-URL: Source, https://github.com/dylanljones/pyrekordbox
 Project-URL: Documentation, https://pyrekordbox.readthedocs.io/en/stable/
 Project-URL: Tracker, https://github.com/dylanljones/pyrekordbox/issues
 Platform: any
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Information Technology
 Classifier: License :: OSI Approved :: MIT License
@@ -48,14 +48,12 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: bidict>=0.21.0
-Requires-Dist: blowfish>=0.6.0
 Requires-Dist: construct>=2.10.0
 Requires-Dist: numpy>=1.19.0
 Requires-Dist: packaging
 Requires-Dist: psutil>=5.9.0
 Requires-Dist: sqlalchemy>=2.0.0
 Requires-Dist: sqlcipher3-wheels
-Requires-Dist: frida-tools
 Requires-Dist: python-dateutil
 Provides-Extra: test
 Requires-Dist: hypothesis>=6.0.0; extra == "test"
@@ -87,11 +85,9 @@ Pioneers Rekordbox DJ Software. It currently supports
 - Analysis files (ANLZ)
 - My-Setting files
 
-Tested Rekordbox versions: ``5.8.6 | 6.7.7 | 7.0.9``
+Check the [changelog][CHANGELOG] for recent changes!
 
-> [!WARNING]
-> This project is still under development and might contain bugs or have breaking API changes in the future.
-> Check the [changelog][CHANGELOG] for recent changes!
+Tested Rekordbox versions: ``5.8.6 | 6.7.7 | 7.0.9``
 
 
 ## 🔧 Installation
@@ -143,10 +139,6 @@ from pyrekordbox.config import update_config
 update_config("<pioneer_install_dir>", "<pioneer_app_dir>")
 ````
 
-Alternatively the two paths can be specified in a configuration file under the section
-`rekordbox`. Supported configuration files are pyproject.toml, setup.cfg, pyrekordbox.toml,
-pyrekordbox.cfg and pyrekordbox.yaml.
-
 
 ### Rekordbox 6/7 database
 
@@ -193,19 +185,6 @@ So far only a few tables support adding or deleting entries:
 - ``DjmdGenre``: Genres
 - ``DjmdLabel``: Labels
 
-If the automatic key extraction fails the command line interface of ``pyrekordbox``
-provides a command for downloading the key from known sources and writing it to the
-cache file:
-````shell
-python -m pyrekordbox download-key
-````
-Once the key is cached the database can be opened without providing the key.
-The key can also be provided manually:
-````python
-db = Rekordbox6Database(key="<insert key here>")
-````
-
-
 ### Rekordbox XML
 
 The Rekordbox XML database is used for importing (and exporting) Rekordbox collections
@@ -263,9 +242,6 @@ Changing and creating the Rekordbox analysis files is planned as well, but for t
 full structure of the analysis files has to be understood.
 
 Unsupported ANLZ tags:
-  - PCOB
-  - PCO2
-  - PSSI
   - PWV6
   - PWV7
   - PWVC
@@ -317,22 +293,20 @@ instead of opening an issue.
 Pyrekordbox is tested on Windows and MacOS, however some features can't be tested in
 the CI setup since it requires a working Rekordbox installation.
 
+## ♡ Sponsor
+
+If pyrekordbox has helped you or saved you time, consider supporting its development - every coffee makes a difference!
+
+[![BuyMeACoffee](https://raw.githubusercontent.com/pachadotdev/buymeacoffee-badges/main/bmc-white.svg)](https://www.buymeacoffee.com/dylanljones)
+
 
 ## 🔗 Related Projects and References
 
 - [crate-digger]: Java library for fetching and parsing rekordbox exports and track analysis files.
 - [rekordcrate]: Library for parsing Pioneer Rekordbox device exports
 - [supbox]: Get the currently playing track from Rekordbox v6 as Audio Hijack Shoutcast/Icecast metadata, display in your OBS video broadcast or export as JSON.
-- Deep Symmetry has an extensive analysis of Rekordbox's ANLZ and .edb export file formats
+- [Deep Symmetry] has an extensive analysis of Rekordbox's ANLZ and .edb export file formats
   https://djl-analysis.deepsymmetry.org/djl-analysis
-- rekordcrate reverse engineered the format of the Rekordbox MySetting files
-  https://holzhaus.github.io/rekordcrate/rekordcrate/setting/index.html
-- rekordcloud went into detail about the internals of Rekordbox 6
-  https://rekord.cloud/blog/technical-inspection-of-rekordbox-6-and-its-new-internals.
-- supbox has a nice implementation on finding the Rekordbox 6 database key
-  https://github.com/gabek/supbox
-
-
 
 
 [tests-badge]: https://img.shields.io/github/actions/workflow/status/dylanljones/pyrekordbox/tests.yml?branch=master&label=tests&logo=github&style=flat
@@ -379,3 +353,4 @@ the CI setup since it requires a working Rekordbox installation.
 [rekordcrate]: https://github.com/Holzhaus/rekordcrate
 [crate-digger]: https://github.com/Deep-Symmetry/crate-digger
 [supbox]: https://github.com/gabek/supbox
+[Deep Symmetry]: https://deepsymmetry.org/

{pyrekordbox-0.4.3 → pyrekordbox-0.4.4}/README.md

@@ -22,11 +22,9 @@ Pioneers Rekordbox DJ Software. It currently supports
 - Analysis files (ANLZ)
 - My-Setting files
 
-Tested Rekordbox versions: ``5.8.6 | 6.7.7 | 7.0.9``
+Check the [changelog][CHANGELOG] for recent changes!
 
-> [!WARNING]
-> This project is still under development and might contain bugs or have breaking API changes in the future.
-> Check the [changelog][CHANGELOG] for recent changes!
+Tested Rekordbox versions: ``5.8.6 | 6.7.7 | 7.0.9``
 
 
 ## 🔧 Installation
@@ -78,10 +76,6 @@ from pyrekordbox.config import update_config
 update_config("<pioneer_install_dir>", "<pioneer_app_dir>")
 ````
 
-Alternatively the two paths can be specified in a configuration file under the section
-`rekordbox`. Supported configuration files are pyproject.toml, setup.cfg, pyrekordbox.toml,
-pyrekordbox.cfg and pyrekordbox.yaml.
-
 
 ### Rekordbox 6/7 database
 
@@ -128,19 +122,6 @@ So far only a few tables support adding or deleting entries:
 - ``DjmdGenre``: Genres
 - ``DjmdLabel``: Labels
 
-If the automatic key extraction fails the command line interface of ``pyrekordbox``
-provides a command for downloading the key from known sources and writing it to the
-cache file:
-````shell
-python -m pyrekordbox download-key
-````
-Once the key is cached the database can be opened without providing the key.
-The key can also be provided manually:
-````python
-db = Rekordbox6Database(key="<insert key here>")
-````
-
-
 ### Rekordbox XML
 
 The Rekordbox XML database is used for importing (and exporting) Rekordbox collections
@@ -198,9 +179,6 @@ Changing and creating the Rekordbox analysis files is planned as well, but for t
 full structure of the analysis files has to be understood.
 
 Unsupported ANLZ tags:
-  - PCOB
-  - PCO2
-  - PSSI
   - PWV6
   - PWV7
   - PWVC
@@ -252,22 +230,20 @@ instead of opening an issue.
 Pyrekordbox is tested on Windows and MacOS, however some features can't be tested in
 the CI setup since it requires a working Rekordbox installation.
 
+## ♡ Sponsor
+
+If pyrekordbox has helped you or saved you time, consider supporting its development - every coffee makes a difference!
+
+[![BuyMeACoffee](https://raw.githubusercontent.com/pachadotdev/buymeacoffee-badges/main/bmc-white.svg)](https://www.buymeacoffee.com/dylanljones)
+
 
 ## 🔗 Related Projects and References
 
 - [crate-digger]: Java library for fetching and parsing rekordbox exports and track analysis files.
 - [rekordcrate]: Library for parsing Pioneer Rekordbox device exports
 - [supbox]: Get the currently playing track from Rekordbox v6 as Audio Hijack Shoutcast/Icecast metadata, display in your OBS video broadcast or export as JSON.
-- Deep Symmetry has an extensive analysis of Rekordbox's ANLZ and .edb export file formats
+- [Deep Symmetry] has an extensive analysis of Rekordbox's ANLZ and .edb export file formats
   https://djl-analysis.deepsymmetry.org/djl-analysis
-- rekordcrate reverse engineered the format of the Rekordbox MySetting files
-  https://holzhaus.github.io/rekordcrate/rekordcrate/setting/index.html
-- rekordcloud went into detail about the internals of Rekordbox 6
-  https://rekord.cloud/blog/technical-inspection-of-rekordbox-6-and-its-new-internals.
-- supbox has a nice implementation on finding the Rekordbox 6 database key
-  https://github.com/gabek/supbox
-
-
 
 
 [tests-badge]: https://img.shields.io/github/actions/workflow/status/dylanljones/pyrekordbox/tests.yml?branch=master&label=tests&logo=github&style=flat
@@ -314,3 +290,4 @@ the CI setup since it requires a working Rekordbox installation.
 [rekordcrate]: https://github.com/Holzhaus/rekordcrate
 [crate-digger]: https://github.com/Deep-Symmetry/crate-digger
 [supbox]: https://github.com/gabek/supbox
+[Deep Symmetry]: https://deepsymmetry.org/

{pyrekordbox-0.4.3 → pyrekordbox-0.4.4}/docs/source/index.md

@@ -44,7 +44,6 @@ caption: User Guide
 
 quickstart
 installation
-key
 tutorial/index
 api
 ```

{pyrekordbox-0.4.3 → pyrekordbox-0.4.4}/docs/source/tutorial/db6.md

@@ -1,14 +1,14 @@
 # Rekordbox 6 Database
 
 Pyrekordbox uses [SQLALchemy](https://www.sqlalchemy.org/) as ORM-Framework to handle the
-Rekordbox v6 database file (``master.db``). The table declarations can be found in
+Rekordbox database file (``master.db``). The table declarations can be found in
 ``pyrekordbox.db6.tables``.
 
 ```{seealso}
 See the {ref}`Rekordbox 6 Database Format <Rekordbox 6 Database Format>` documentation for more information.
 ```
 
-Since the Rekordbox v6 database handler automatically finds the ``master.db`` database file
+Since the Rekordbox database handler automatically finds the ``master.db`` database file
 (see configuration), it can be initialized without any arguments:
 ````python
 from pyrekordbox import Rekordbox6Database
@@ -16,28 +16,6 @@ from pyrekordbox import Rekordbox6Database
 db = Rekordbox6Database()
 ````
 
-If the automatic key extraction fails the command line interface of ``pyrekordbox``
-provides a command for downloading the key from known sources and writing it to the
-cache file:
-````shell
-python -m pyrekordbox download-key
-````
-Once the key is cached the database can be opened without providing the key.
-If you obtained the key from another source, you can also pass it to the database handler
-````python
-db = Rekordbox6Database(key="<insert key here>")
-````
-or write it to the cache file manually:
-````python
-from pyrekordbox.config import write_db6_key_cache
-
-write_db6_key_cache("<insert key here>")  # call once
-db = Rekordbox6Database()
-````
-The key can be found in some other projects (see issue
-[#77](https://github.com/dylanljones/pyrekordbox/issues/77)), for example [here][rb6-key].
-
-
 ## Querying the database
 
 A query can be executed on any table by calling the ``query()`` method. The result is
@@ -203,4 +181,3 @@ More coming soon!
 [DjmdPlaylist]: pyrekordbox.db6.tables.DjmdPlaylist
 [djmdSongPlaylist-table]: #djmdSongPlaylist
 [DjmdSongPlaylist]: pyrekordbox.db6.tables.DjmdSongPlaylist
-[rb6-key]: https://github.com/mganss/CueGen/blob/19878e6eb3f586dee0eb3eb4f2ce3ef18309de9d/CueGen/Generator.cs#L31

{pyrekordbox-0.4.3 → pyrekordbox-0.4.4}/pyproject.toml

@@ -11,7 +11,7 @@ authors = [
 license = {file = "LICENSE"}
 dynamic = ["version"]
 classifiers = [
-    "Development Status :: 3 - Alpha",
+    "Development Status :: 4 - Beta",
     "Intended Audience :: Developers",
     "Intended Audience :: Information Technology",
     "License :: OSI Approved :: MIT License",
@@ -30,14 +30,12 @@ classifiers = [
 requires-python = ">=3.8"
 dependencies = [
     "bidict>=0.21.0",
-    "blowfish>=0.6.0",
     "construct>=2.10.0",
     "numpy>=1.19.0",
     "packaging",
     "psutil>=5.9.0",
     "sqlalchemy>=2.0.0",
     "sqlcipher3-wheels",
-    "frida-tools",
     "python-dateutil",
 ]
 

{pyrekordbox-0.4.3 → pyrekordbox-0.4.4}/pyrekordbox/__main__.py

@@ -3,30 +3,10 @@
 # Date:   2023-08-15
 
 import os
-import re
 import shutil
 import sys
-import urllib.request
 from pathlib import Path
 
-from pyrekordbox.config import get_cache_file, write_db6_key_cache
-
-KEY_SOURCES = [
-    {
-        "url": r"https://raw.githubusercontent.com/mganss/CueGen/19878e6eb3f586dee0eb3eb4f2ce3ef18309de9d/CueGen/Generator.cs",  # noqa: E501
-        "regex": re.compile(
-            r'((.|\n)*)Config\.UseSqlCipher.*\?.*"(?P<dp>.*)".*:.*null',
-            flags=re.IGNORECASE | re.MULTILINE,
-        ),
-    },
-    {
-        "url": r"https://raw.githubusercontent.com/dvcrn/go-rekordbox/8be6191ba198ed7abd4ad6406d177ed7b4f749b5/cmd/getencryptionkey/main.go",  # noqa: E501
-        "regex": re.compile(
-            r'((.|\n)*)fmt\.Print\("(?P<dp>.*)"\)', flags=re.IGNORECASE | re.MULTILINE
-        ),
-    },
-]
-
 
 class WorkingDir:
     def __init__(self, path):
@@ -130,40 +110,12 @@ def install_pysqlcipher(
             print(f"Could not remove temporary directory '{tmpdir}'!")
 
 
-def download_db6_key():
-    dp = ""
-    for source in KEY_SOURCES:
-        url = source["url"]
-        regex = source["regex"]
-        print(f"Looking for key: {url}")
-
-        res = urllib.request.urlopen(url)
-        data = res.read().decode("utf-8")
-        match = regex.match(data)
-        if match:
-            dp = match.group("dp")
-            break
-    if dp:
-        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.")
-
-
 def main():
     from argparse import ArgumentParser
 
     parser = ArgumentParser("pyrekordbox")
     subparsers = parser.add_subparsers(dest="command")
 
-    # Download Rekordbx 6 database key command
-    subparsers.add_parser(
-        "download-key",
-        help="Download the Rekordbox 6 database key from the internet "
-        "and write it to the cache file.",
-    )
-
     # Install pysqlcipher3 command (Windows only)
     install_parser = subparsers.add_parser(
         "install-sqlcipher",
@@ -192,9 +144,7 @@ def main():
 
     # Parse args and handle command
     args = parser.parse_args(sys.argv[1:])
-    if args.command == "download-key":
-        download_db6_key()
-    elif args.command == "install-sqlcipher":
+    if args.command == "install-sqlcipher":
         install_pysqlcipher(args.tmpdir, args.cryptolib, install=not args.buildonly)
 
 

{pyrekordbox-0.4.3 → pyrekordbox-0.4.4}/pyrekordbox/_version.py

@@ -1,7 +1,14 @@
 # file generated by setuptools-scm
 # don't change, don't track in version control
 
-__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
 
 TYPE_CHECKING = False
 if TYPE_CHECKING:
@@ -9,13 +16,19 @@ if TYPE_CHECKING:
     from typing import Union
 
     VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
 else:
     VERSION_TUPLE = object
+    COMMIT_ID = object
 
 version: str
 __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
 
-__version__ = version = '0.4.3'
-__version_tuple__ = version_tuple = (0, 4, 3)
+__version__ = version = '0.4.4'
+__version_tuple__ = version_tuple = (0, 4, 4)
+
+__commit_id__ = commit_id = 'gec8cd22'

{pyrekordbox-0.4.3 → pyrekordbox-0.4.4}/pyrekordbox/anlz/file.py

@@ -108,30 +108,36 @@ class AnlzFile(abc.Mapping):  # type: ignore[type-arg]
             # Get the four byte struct type
             tag_type = tag_data[:4].decode("ascii")
 
+            # Get tag length from generic tag header
+            tag_struct = structs.AnlzTag.parse(tag_data)
+            len_tag = tag_struct.len_tag
+
             if tag_type == "PSSI":
                 # The version that rekordbox 6 *exports* is garbled with an XOR mask.
+                # Determine if the tag is garbled by checking the initial (masked) mood value.
                 # All bytes after byte 17 (len_e) are XOR-masked with a pattern that is
                 # generated by adding the value of len_e to each byte of XOR_MASK
 
                 # Check if the file is garbled (only on exported files)
                 # For this we check the validity of mood and bank
                 # Mood: High=1, Mid=2, Low=3
-                # Bank: 0-8
                 mood = Int16ub.parse(tag_data[18:20])
-                bank = Int16ub.parse(tag_data[28:30])
-                if 1 <= mood <= 3 and 0 <= bank <= 8:
+                if 1 <= mood <= 3:
                     logger.debug("PSSI is not garbled!")
                 else:
-                    logger.debug("PSSI is garbled!")
-                    # deobfuscate tag_data[18:] using xor with XOR_MASK+len_entries
-                    len_entries = Int16ub.parse(tag_data[16:])
-                    tag_data = bytearray(data[i : i + len(tag_data)])
-                    for x in range(len(tag_data[18:])):
+                    logger.debug("PSSI is garbled! (raw_mood=%s)", mood)
+                    len_entries = Int16ub.parse(tag_data[16:18])
+
+                    # Copy only this tag's data so we don't mutate the remainder of file slice
+                    mutable_tag_data = bytearray(tag_data[:len_tag])
+
+                    for x in range(len(mutable_tag_data) - 18):
                         mask = XOR_MASK[x % len(XOR_MASK)] + len_entries
                         if mask > 255:
                             mask -= 256
-                        tag_data[x + 18] ^= mask
-                    tag_data = bytes(tag_data)
+                        mutable_tag_data[18 + x] ^= mask
+
+                    tag_data = bytes(mutable_tag_data)
 
             try:
                 # Parse the struct
@@ -140,7 +146,7 @@ class AnlzFile(abc.Mapping):  # type: ignore[type-arg]
                     raise StructNotInitializedError()
                 tags.append(tag)
                 len_header = tag.struct.len_header
-                len_tag = tag.struct.len_tag
+
                 logger.debug(
                     "Parsed struct '%s' (len_header=%s, len_tag=%s)",
                     tag_type,
@@ -149,8 +155,7 @@ class AnlzFile(abc.Mapping):  # type: ignore[type-arg]
                 )
             except KeyError:
                 logger.warning("Tag '%s' not supported!", tag_type)
-                tag_struct = structs.AnlzTag.parse(tag_data)
-                len_tag = tag_struct.len_tag
+
             i += len_tag
 
         self.file_header = file_header