pyrekordbox 0.3.2__tar.gz → 0.4.1__tar.gz

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

@@ -43,7 +43,7 @@ jobs:
     strategy:
       matrix:
         os: [windows-latest, macos-latest]
-        python-version: ["3.8", "3.12"]  # check oldest and latest supported version
+        python-version: ["3.8", "3.13"]  # check oldest and latest supported version
         other-os: [true]
 
     runs-on: ${{ matrix.os }}

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

@@ -3,7 +3,7 @@
 
 repos:
     - repo: https://github.com/pre-commit/pre-commit-hooks
-      rev: v4.5.0
+      rev: v5.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.1.9
+      rev: v0.11.4
       hooks:
         # Run the linter.
         - id: ruff

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

@@ -1,5 +1,69 @@
 # What's New
 
+
+<a name="v0.4.1"></a>
+## [v0.4.1] - 2025-04-20
+
+This release improves database functionality by allowing commits when playlists are missing in 
+XML (with warnings for non-special playlists), adds timezone support for date fields, 
+and fixes date format issues. 
+Configuration enhancements include relocating the pyrekordbox cache file to the user's 
+appdata directory and fixing an asar file decoding error.
+
+### Improvements/Bug Fixes
+
+- **db:** **allow commiting if playlist is not found in XML ([#149](https://github.com/dylanljones/pyrekordbox/issues/149))**  
+  This fixes an issue where the changes to the DB can not be commited if the playlist is missing 
+  in the playlist-xml. A warning is now shown instead. The warning is not shown for special 
+  playlists.
+- **db:** **add timezone support and fix date format issue ([#161](https://github.com/dylanljones/pyrekordbox/issues/161))**  
+  Date formats in the DB are now converted to the local timezone. It is now also possible to read date fields with other formats.
+- **config:** **move pyrekordbox cache file to appdir**  
+  The cache file is now stored in the appdata directory of the user. 
+  This avoids writing to the pyrekordbox package directory.
+- **config:** **fix asar file decoding error ([#154](https://github.com/dylanljones/pyrekordbox/issues/154))**  
+
+
+<a name="v0.4.0"></a>
+## [v0.4.0] - 2025-02-12
+
+This release adds the ability to create new tracks in the Rekordbox v6 database.
+It also adds support for Rekordbox 7 and fixes various bugs.
+
+### New Features
+
+- **db:** **add method for creating tracks ([#121](https://github.com/dylanljones/pyrekordbox/pull/121))**  
+  New tracks can now be created and added to the Rekordbox collection.
+  Note that the user still has to reload tags/analyze the newly added tracks in Rekordbox.
+- **config:** **add Rekordbox 7 support ([#133](https://github.com/dylanljones/pyrekordbox/issues/133))**  
+
+### Improvements/Bug Fixes
+
+- **db:** **fix missing proxy association in table dict**  
+  The association proxies were missing in the `to_dict` method.
+  The keys are now also cached.
+- **db:** **fix an error with .aif file extension ([#138](https://github.com/dylanljones/pyrekordbox/pull/138))**
+- **db:** **fix to smartlist not always working correctly due to unneccessary bit shift for specific MyTag values ([#142](https://github.com/dylanljones/pyrekordbox/pull/142))**  
+  Fix smartlists not always working correctly due to unneccessary bit shift for specific MyTag values
+- **db:** **fix different timezone assertion ([#137](https://github.com/dylanljones/pyrekordbox/pull/137))**  
+  Allow different timezones other than "+00:00" in the datetime format of the DB.
+- **xml:** **save xml as utf-8 ([#135](https://github.com/dylanljones/pyrekordbox/pull/135))**  
+- **build:** **use pre-built sqlcipher wheels as dependency ([#134](https://github.com/dylanljones/pyrekordbox/pull/134))**  
+  The sqlcipher dependency can now be installed using pre-built wheels with included sqlcipher binaries. This makes the whole library installable via pip!
+- **xml:** **remove deprecated `xml` module**  
+- **db:** **remove deprecated `open_rekordbox_database` method**  
+
+### Documentation
+
+- **db:** **add documentation for adding tracks**
+- **db:** **add more info to djmdContent table**
+
+### BREAKING CHANGE
+
+Remove deprecated `open_rekordbox_database` method. Use the `Rekordbox6Database` database handler instead!  
+Remove deprecated `xml` module. Use the `rbxml` module instead!
+
+
 <a name="v0.3.2"></a>
 ## [v0.3.2] - 2024-01-05
 
@@ -570,7 +634,9 @@ This release contains documentation fixes.
 - **add missing djmd tables to `master.db` database documentation**
 
 
-[Unreleased]: https://github.com/dylanljones/pyrekordbox/compare/v0.3.2...HEAD
+[Unreleased]: https://github.com/dylanljones/pyrekordbox/compare/v0.4.1...HEAD
+[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
 [v0.3.1]: https://github.com/dylanljones/pyrekordbox/compare/0.3.0...v0.3.1
 [0.3.0]: https://github.com/dylanljones/pyrekordbox/compare/0.2.3...0.3.0

{pyrekordbox-0.3.2 → pyrekordbox-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: pyrekordbox
-Version: 0.3.2
+Version: 0.4.1
 Summary: Inofficial Python package for interacting with the library of Pioneers Rekordbox DJ software.
 Author-email: Dylan Jones <dylanljones94@gmail.com>
 License: MIT License
@@ -54,12 +54,14 @@ 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"
 Requires-Dist: pytest>=6.2.0; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"
+Dynamic: license-file
 
 
 <p align="center">
@@ -85,11 +87,11 @@ Pioneers Rekordbox DJ Software. It currently supports
 - Analysis files (ANLZ)
 - My-Setting files
 
-Tested Rekordbox versions: ``5.8.6 | 6.5.3 | 6.7.7``
+Tested Rekordbox versions: ``5.8.6 | 6.7.7 | 7.0.9``
 
-
-|⚠️| 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! |
-|----|:----------------------------------------------------------------------------------------------------------------------------------------------------------------|
+> [!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!
 
 
 ## 🔧 Installation
@@ -107,40 +109,20 @@ where `VERSION` is a release, tag or branch name.
 
 ### Dependencies
 
-Unlocking the new Rekordbox 6 `master.db` database file requires [SQLCipher][sqlcipher].
-Pyrekordbox makes no attempt to download/install SQLCipher, as it is a
-pure Python package - whereas the SQLCipher/sqlcipher3 installation is
-platform-dependent and can not be installed via ``pip``.
-
-#### Windows
-
-SQLCipher can be used by building the libary against an amalgamation with [sqlcipher3].
-For a detailed instruction, see the [installation guide][installation].
-
-#### MacOS
 
-For MacOS follow these steps:
-
-1) Install [Homebrew](https://brew.sh) if you do not have it on your machine.
-2) Install SQLCipher with `brew install SQLCipher`.
-3) With the python environment you are using to run pyrekordbox active execute the following:
-```shell
-git clone https://github.com/coleifer/sqlcipher3
-cd sqlcipher3
-SQLCIPHER_PATH=$(brew info sqlcipher | awk 'NR==4 {print $1; exit}'); C_INCLUDE_PATH="$SQLCIPHER_PATH"/include LIBRARY_PATH="$SQLCIPHER_PATH"/lib python setup.py build
-SQLCIPHER_PATH=$(brew info sqlcipher | awk 'NR==4 {print $1; exit}'); C_INCLUDE_PATH="$SQLCIPHER_PATH"/include LIBRARY_PATH="$SQLCIPHER_PATH"/lib python setup.py install
-```
-Make sure the `C_INCLUDE` and `LIBRARY_PATH` point to the installed SQLCipher path. It may differ on your machine.
-If you are having issues installing [sqlcipher3] on M1 Macs please refer to the
-[installation guide][installation].
+Unlocking the new Rekordbox 6 `master.db` database file requires [SQLCipher][sqlcipher].
+Pyrekordbox tries to install pre-built wheels with included sqlcipher binaries via the [sqlcipher3-wheels] package.
+If this fails, it can be installed manually following the [installation guide][installation].
 
 
 ## 🚀 Quick-Start
 
 [Read the full documentation on ReadTheDocs!][documentation]
 
-| ❗  | Please make sure to back up your Rekordbox collection before making changes with pyrekordbox or developing/testing new features. The backup dialog can be found under "File" > "Library" > "Backup Library" |
-|----|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+> [!CAUTION]
+> Please make sure to back up your Rekordbox collection before making changes with pyrekordbox
+> or developing/testing new features.
+> The backup dialog can be found under "File" > "Library" > "Backup Library"
 
 
 ### Configuration
@@ -166,10 +148,10 @@ Alternatively the two paths can be specified in a configuration file under the s
 pyrekordbox.cfg and pyrekordbox.yaml.
 
 
-### Rekordbox 6 database
+### Rekordbox 6/7 database
 
-Rekordbox 6 now uses a SQLite database for storing the collection content.
-Unfortunatly, the new `master.db` SQLite database is encrypted using
+Rekordbox 6 and 7 use a SQLite database for storing the collection content.
+Unfortunatly, the `master.db` SQLite database is encrypted using
 [SQLCipher][sqlcipher], which means it can't be used without the encryption key.
 However, since your data is stored and used locally, the key must be present on the
 machine running Rekordbox.
@@ -195,10 +177,15 @@ can be changed via the corresponding property of the object:
 ````python
 content = db.get_content()[0]
 content.Title = "New Title"
+db.commit()
 ````
-Some fields are stored as references to other tables, for example the artist of a track.
-Check the [documentation][db6-doc] of the corresponding object for more information.
+
+> [!NOTE]
+> Some fields are stored as references to other tables, for example the artist of a track.
+> Check the [documentation][db6-doc] of the corresponding object for more information.
+
 So far only a few tables support adding or deleting entries:
+- ``DjmdContent``: Tracks
 - ``DjmdPlaylist``: Playlists/Playlist Folders
 - ``DjmdSongPlaylist``: Songs in a playlist
 - ``DjmdAlbum``: Albums
@@ -388,7 +375,7 @@ the CI setup since it requires a working Rekordbox installation.
 
 [repo]: https://github.com/dylanljones/pyrekordbox
 [sqlcipher]: https://www.zetetic.net/sqlcipher/open-source/
-[sqlcipher3]: https://github.com/coleifer/sqlcipher3
+[sqlcipher3-wheels]: https://github.com/laggykiller/sqlcipher3
 [rekordcrate]: https://github.com/Holzhaus/rekordcrate
 [crate-digger]: https://github.com/Deep-Symmetry/crate-digger
 [supbox]: https://github.com/gabek/supbox

{pyrekordbox-0.3.2 → pyrekordbox-0.4.1}/README.md

@@ -22,11 +22,11 @@ Pioneers Rekordbox DJ Software. It currently supports
 - Analysis files (ANLZ)
 - My-Setting files
 
-Tested Rekordbox versions: ``5.8.6 | 6.5.3 | 6.7.7``
+Tested Rekordbox versions: ``5.8.6 | 6.7.7 | 7.0.9``
 
-
-|⚠️| 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! |
-|----|:----------------------------------------------------------------------------------------------------------------------------------------------------------------|
+> [!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!
 
 
 ## 🔧 Installation
@@ -44,40 +44,20 @@ where `VERSION` is a release, tag or branch name.
 
 ### Dependencies
 
-Unlocking the new Rekordbox 6 `master.db` database file requires [SQLCipher][sqlcipher].
-Pyrekordbox makes no attempt to download/install SQLCipher, as it is a
-pure Python package - whereas the SQLCipher/sqlcipher3 installation is
-platform-dependent and can not be installed via ``pip``.
-
-#### Windows
-
-SQLCipher can be used by building the libary against an amalgamation with [sqlcipher3].
-For a detailed instruction, see the [installation guide][installation].
-
-#### MacOS
 
-For MacOS follow these steps:
-
-1) Install [Homebrew](https://brew.sh) if you do not have it on your machine.
-2) Install SQLCipher with `brew install SQLCipher`.
-3) With the python environment you are using to run pyrekordbox active execute the following:
-```shell
-git clone https://github.com/coleifer/sqlcipher3
-cd sqlcipher3
-SQLCIPHER_PATH=$(brew info sqlcipher | awk 'NR==4 {print $1; exit}'); C_INCLUDE_PATH="$SQLCIPHER_PATH"/include LIBRARY_PATH="$SQLCIPHER_PATH"/lib python setup.py build
-SQLCIPHER_PATH=$(brew info sqlcipher | awk 'NR==4 {print $1; exit}'); C_INCLUDE_PATH="$SQLCIPHER_PATH"/include LIBRARY_PATH="$SQLCIPHER_PATH"/lib python setup.py install
-```
-Make sure the `C_INCLUDE` and `LIBRARY_PATH` point to the installed SQLCipher path. It may differ on your machine.
-If you are having issues installing [sqlcipher3] on M1 Macs please refer to the
-[installation guide][installation].
+Unlocking the new Rekordbox 6 `master.db` database file requires [SQLCipher][sqlcipher].
+Pyrekordbox tries to install pre-built wheels with included sqlcipher binaries via the [sqlcipher3-wheels] package.
+If this fails, it can be installed manually following the [installation guide][installation].
 
 
 ## 🚀 Quick-Start
 
 [Read the full documentation on ReadTheDocs!][documentation]
 
-| ❗  | Please make sure to back up your Rekordbox collection before making changes with pyrekordbox or developing/testing new features. The backup dialog can be found under "File" > "Library" > "Backup Library" |
-|----|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+> [!CAUTION]
+> Please make sure to back up your Rekordbox collection before making changes with pyrekordbox
+> or developing/testing new features.
+> The backup dialog can be found under "File" > "Library" > "Backup Library"
 
 
 ### Configuration
@@ -103,10 +83,10 @@ Alternatively the two paths can be specified in a configuration file under the s
 pyrekordbox.cfg and pyrekordbox.yaml.
 
 
-### Rekordbox 6 database
+### Rekordbox 6/7 database
 
-Rekordbox 6 now uses a SQLite database for storing the collection content.
-Unfortunatly, the new `master.db` SQLite database is encrypted using
+Rekordbox 6 and 7 use a SQLite database for storing the collection content.
+Unfortunatly, the `master.db` SQLite database is encrypted using
 [SQLCipher][sqlcipher], which means it can't be used without the encryption key.
 However, since your data is stored and used locally, the key must be present on the
 machine running Rekordbox.
@@ -132,10 +112,15 @@ can be changed via the corresponding property of the object:
 ````python
 content = db.get_content()[0]
 content.Title = "New Title"
+db.commit()
 ````
-Some fields are stored as references to other tables, for example the artist of a track.
-Check the [documentation][db6-doc] of the corresponding object for more information.
+
+> [!NOTE]
+> Some fields are stored as references to other tables, for example the artist of a track.
+> Check the [documentation][db6-doc] of the corresponding object for more information.
+
 So far only a few tables support adding or deleting entries:
+- ``DjmdContent``: Tracks
 - ``DjmdPlaylist``: Playlists/Playlist Folders
 - ``DjmdSongPlaylist``: Songs in a playlist
 - ``DjmdAlbum``: Albums
@@ -325,7 +310,7 @@ the CI setup since it requires a working Rekordbox installation.
 
 [repo]: https://github.com/dylanljones/pyrekordbox
 [sqlcipher]: https://www.zetetic.net/sqlcipher/open-source/
-[sqlcipher3]: https://github.com/coleifer/sqlcipher3
+[sqlcipher3-wheels]: https://github.com/laggykiller/sqlcipher3
 [rekordcrate]: https://github.com/Holzhaus/rekordcrate
 [crate-digger]: https://github.com/Deep-Symmetry/crate-digger
 [supbox]: https://github.com/gabek/supbox

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

@@ -270,7 +270,7 @@ corresponding ID.
      -
    * - `FileType`
      - Type of audio file
-     - mp3= `0` / `1` , m4a= `4` , wav= `11` , aiff= `12`
+     - mp3= `0` / `1` , m4a= `4` , flac= `5` , wav= `11` , aiff= `12`
    * - `Rating`
      - Rating of the track
      -
@@ -302,8 +302,8 @@ corresponding ID.
      - Path to the tracks album artwork
      - The path is relative to the Rekordbox database root
    * - `MasterDBID`
-     - The master-ID of the track
-     - Not sure whats the difference to `ID`
+     - The database where the track is stored
+     - Links to `DBID` in the `DjmdProperty` table
    * - `MasterSongID`
      - The master-song-ID of the track
      - Not sure whats the difference to `ID` and `MasterDBID`
@@ -341,7 +341,7 @@ corresponding ID.
      - Date of file creation
      - Format: yyyy-mm-dd; ex.: 2010-08-21
    * - `ContentLink`
-     - ?
+     - Link to the `rb_local_usn` of `TRACK` in `DjmdMenuItems`?
      -
    * - `Tag`
      - My tag value
@@ -413,7 +413,7 @@ corresponding ID.
      - The Rekordbox ID of the file
      -
    * - `DeviceID`
-     - ?
+     - The ID of the DjmdDevice this track is stored on.
      -
    * - `rb_LocalFolderPath`
      - ?

{pyrekordbox-0.3.2 → pyrekordbox-0.4.1}/docs/source/installation.md

@@ -23,9 +23,8 @@ $ pip install .
 ## Installing SQLCipher
 
 Unlocking the new Rekordbox 6 `master.db` database file requires [SQLCipher][sqlcipher].
-Pyrekordbox makes no attempt to download/install SQLCipher, as it is a
-pure Python package - whereas the SQLCipher/sqlcipher3 installation is
-platform-dependent and can not be installed easily via ``pip``.
+Pyrekordbox tries to install pre-built wheels with included sqlcipher binaries via the [sqlcipher3-wheels] package.
+If this fails, it can be installed manually following the instructions below.
 
 [sqlcipher3] can either be built with the system [SQLCipher][sqlcipher] or built against
 a statically linked amalgamation of the SQLite3 source code.
@@ -186,8 +185,8 @@ For building [sqlcipher3] against the system SQLCipher installation on MacOS fol
 ```shell
 git clone https://github.com/coleifer/sqlcipher3
 cd sqlcipher3
-SQLCIPHER_PATH=$(brew info sqlcipher | awk 'NR==4 {print $1; exit}'); C_INCLUDE_PATH="$SQLCIPHER_PATH"/include LIBRARY_PATH="$SQLCIPHER_PATH"/lib python setup.py build
-SQLCIPHER_PATH=$(brew info sqlcipher | awk 'NR==4 {print $1; exit}'); C_INCLUDE_PATH="$SQLCIPHER_PATH"/include LIBRARY_PATH="$SQLCIPHER_PATH"/lib python setup.py install
+SQLCIPHER_PATH=$(brew info sqlcipher | awk 'NR==5 {print $1; exit}'); C_INCLUDE_PATH="$SQLCIPHER_PATH"/include LIBRARY_PATH="$SQLCIPHER_PATH"/lib python setup.py build
+SQLCIPHER_PATH=$(brew info sqlcipher | awk 'NR==5 {print $1; exit}'); C_INCLUDE_PATH="$SQLCIPHER_PATH"/include LIBRARY_PATH="$SQLCIPHER_PATH"/lib python setup.py install
 ```
 Make sure the `C_INCLUDE` and `LIBRARY_PATH` point to the installed SQLCipher path. It may differ on your machine.
 
@@ -269,3 +268,4 @@ c.execute("PRAGMA key='password'")
 [Pypi]: https://pypi.org/project/pyrekordbox/
 [GitHub]: https://github.com/dylanljones/pyrekordbox
 [sqlcipher]: https://www.zetetic.net/sqlcipher/open-source/
+[sqlcipher3-wheels]: https://github.com/laggykiller/sqlcipher3

{pyrekordbox-0.3.2 → pyrekordbox-0.4.1}/docs/source/tutorial/db6.md

@@ -160,6 +160,34 @@ song = playlist.Songs[0]
 db.remove_from_playlist(playlist, song)
 ````
 
+### Tracks
+
+New tracks can be added to your rekordbox collection by calling the `db.add_content()` method:
+
+```python
+track = db.add_content("/Users/deadmau5/Downloads/Banger.mp3")
+```
+
+This creates a new [DjmdContent] instance and adds it to the [djmdContent-table]. This
+track will appear in your rekordbox collection, but the track metadata (title, artist,
+etc.) will be blank. To load this data, simply right click the track and select the
+`Reload Tag` menu option. rekordbox will correctly populate the metadata, including
+creating any related table data for things like artist and album.
+
+The `db.add_content()` method accepts `**kwargs` which are passed on to the [DjmdContent]
+instance. You can use these keyword arguments if you want to populate some of the track
+metadata right away. However, things like [DjmdArtist] and [DjmdAlbum] are foreign keys to
+other tables, so make sure you create these objects first and pass the objects via kwargs,
+rather than passing plain strings. A plain string will work for `Title`, however.
+
+```python
+db.add_content("/Users/deadmau5/Downloads/Banger.mp3", Title="Banger")
+```
+
+Populating the [DjmdContent] metadata directly from the track file is not currently
+supported, but it will hopefully be included in a future release.
+
+
 ```{note}
 More coming soon!
 ```

{pyrekordbox-0.3.2 → pyrekordbox-0.4.1}/pyproject.toml

@@ -36,6 +36,7 @@ dependencies = [
     "packaging",
     "psutil>=5.9.0",
     "sqlalchemy>=2.0.0",
+    "sqlcipher3-wheels",
     "frida-tools",
     "python-dateutil",
 ]
@@ -69,8 +70,9 @@ platforms = ["any"]
 zip-safe = false
 include-package-data = true
 
-[tool.setuptools.packages]
-find = {}
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["pyrekordbox", "pyrekordbox.*"]
 
 [tool.setuptools_scm]
 write_to = "pyrekordbox/_version.py"
@@ -91,7 +93,7 @@ exclude = [
     "*/_version.py",
     "docs/*",
 ]
-line-length = 88
+line-length = 100
 indent-width = 4
 
 [tool.ruff.lint]
@@ -99,20 +101,45 @@ select = [
     "F", # flake8
     "E", # pycodestyle Errors
     "W", # pycodestyle Warnings
-    # "I", # isort
+    "I", # isort
+    "NPY", # Numpy
+    "N", # pep8-naming
+    "D", # pydocstyle
 ]
 ignore = [
     "E203",  # Whitespace before ':'
+    "D100", # Missing docstring in public module
+    "D101", # Missing docstring in public class
+    "D102", # Missing docstring in public method
+    "D103", # Missing docstring in public function
+    "D104", # Missing docstring in public package
+    "D105", # Missing docstring in magic method
+    "D106", # Missing docstring in public nested class
+    "D107", # Missing docstring in __init__
+    "D401", # First line should be in imperative mood
+    "D403", # First word of the first line should be capitalized
+    "D404", # First word of the docstring should not be "This"
+    #"N802", # Function name should be lowercase
+    #"N803", # Argument name should be lowercase
+    "N813", # Camelcase imported as lowercase
+    #"N815", # Variable in class scope should not be mixedCase
+    "N818", # Exception name should be named with an Error suffix
 ]
 fixable = ["ALL"]  # Allow fix for all enabled rules (when `--fix`) is provided.
 unfixable = []
 
 [tool.ruff.lint.per-file-ignores]
 "*__init__.py" = ["F401"]
+"rbxml.py" = ["N803"]
+"tables.py" = ["N802", "N815"]
+
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"
 
 [tool.ruff.lint.isort]
 combine-as-imports = true
-# length-sort = true
+length-sort = false
 
 [tool.ruff.format]
 quote-style = "double"

{pyrekordbox-0.3.2 → pyrekordbox-0.4.1}/pyrekordbox/__init__.py

@@ -2,19 +2,19 @@
 # Author: Dylan Jones
 # Date:   2022-04-10
 
+from .anlz import AnlzFile, get_anlz_paths, read_anlz_files, walk_anlz_paths
+from .config import get_config, show_config, update_config
+from .db6 import Rekordbox6Database
 from .logger import logger
-from .config import show_config, get_config, update_config
-from .rbxml import RekordboxXml, XmlDuplicateError, XmlAttributeKeyError
-from .anlz import get_anlz_paths, walk_anlz_paths, read_anlz_files, AnlzFile
 from .mysettings import (
+    DevSettingFile,
+    DjmMySettingFile,
+    MySetting2File,
+    MySettingFile,
     get_mysetting_paths,
     read_mysetting_file,
-    MySettingFile,
-    MySetting2File,
-    DjmMySettingFile,
-    DevSettingFile,
 )
-from .db6 import Rekordbox6Database, open_rekordbox_database
+from .rbxml import RekordboxXml, XmlAttributeKeyError, XmlDuplicateError
 
 try:
     from ._version import version as __version__

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

@@ -4,11 +4,12 @@
 
 import os
 import re
-import sys
 import shutil
+import sys
 import urllib.request
 from pathlib import Path
-from pyrekordbox.config import write_db6_key_cache, _cache_file
+
+from pyrekordbox.config import _cache_file, write_db6_key_cache
 
 KEY_SOURCES = [
     {

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

@@ -1,8 +1,13 @@
-# file generated by setuptools_scm
+# file generated by setuptools-scm
 # don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
 TYPE_CHECKING = False
 if TYPE_CHECKING:
-    from typing import Tuple, Union
+    from typing import Tuple
+    from typing import Union
+
     VERSION_TUPLE = Tuple[Union[int, str], ...]
 else:
     VERSION_TUPLE = object
@@ -12,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.3.2'
-__version_tuple__ = version_tuple = (0, 3, 2)
+__version__ = version = '0.4.1'
+__version_tuple__ = version_tuple = (0, 4, 1)

{pyrekordbox-0.3.2 → pyrekordbox-0.4.1}/pyrekordbox/anlz/__init__.py

@@ -5,6 +5,7 @@
 import re
 from pathlib import Path
 from typing import Union
+
 from . import structs
 from .file import AnlzFile
 
@@ -77,7 +78,7 @@ def walk_anlz_dirs(root_dir: Union[str, Path]):
         The path of the root directory.
 
     Yields
-    -------
+    ------
     anlz_dir : str
         The path of a directory containing ANLZ files
     """
@@ -96,7 +97,7 @@ def walk_anlz_paths(root_dir: Union[str, Path]):
         The path of the root directory.
 
     Yields
-    -------
+    ------
     anlz_dir : str
         The path of a directory containing ANLZ files.
     anlz_files : Sequence of str

{pyrekordbox-0.3.2 → pyrekordbox-0.4.1}/pyrekordbox/anlz/file.py

@@ -6,10 +6,12 @@ import logging
 from collections import abc
 from pathlib import Path
 from typing import Union
-from .tags import TAGS
-from . import structs
+
 from construct import Int16ub
 
+from . import structs
+from .tags import TAGS
+
 logger = logging.getLogger(__name__)
 
 XOR_MASK = bytearray.fromhex("CB E1 EE FA E5 EE AD EE E9 D2 E9 EB E1 E9 F3 E8 E9 F4 E1")