pyrekordbox 0.2.2__tar.gz → 0.3.0__tar.gz

{pyrekordbox-0.2.2 → pyrekordbox-0.3.0}/.github/workflows/codeql.yml

@@ -9,8 +9,33 @@ on:
     - cron: "4 11 * * 1"
 
 jobs:
+
+  code-change:
+    runs-on: ubuntu-latest
+    steps:
+      - id: skip_check
+        uses: fkirc/skip-duplicate-actions@master
+        with:
+          paths_ignore: '[
+          "docs/**",
+          ".github/**",
+          ".resources/**",
+          "logos/**",
+          "README.md",
+          "CHANGELOG.md",
+          "CONTRIBUTING.md",
+          ".pre-commit-config.yaml",
+          ".readthedocs.yaml",
+          "pyproject.toml"
+          ]'
+    outputs:
+      should_skip: ${{ steps.skip_check.outputs.should_skip }}
+
+
   analyze:
     name: Analyze
+    needs: code-change
+    if: ${{ needs.code-change.outputs.should_skip != 'true'}}
     runs-on: ubuntu-latest
     permissions:
       actions: read

{pyrekordbox-0.2.2 → pyrekordbox-0.3.0}/.github/workflows/pypi-publish.yml

@@ -48,14 +48,14 @@ jobs:
 
     - name: Publish distribution 📦 to Test PyPI
       env:
-        TWINE_USERNAME: ${{ secrets.TEST_PYPI_USERNAME }}
-        TWINE_PASSWORD: ${{ secrets.TEST_PYPI_PASSWORD }}
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.TEST_PYPI_TOKEN }}
       run: |
         twine upload --repository testpypi dist/*
 
     - name: Publish distribution 📦 to PyPI
       env:
-        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
-        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
       run: |
         twine upload dist/*

{pyrekordbox-0.2.2 → pyrekordbox-0.3.0}/.github/workflows/tests.yml

@@ -43,11 +43,11 @@ jobs:
     strategy:
       matrix:
         os: [windows-latest, macos-latest]
-        python-version: ["3.7", "3.12"]  # check oldest and latest supported version
+        python-version: ["3.8", "3.12"]  # check oldest and latest supported version
         other-os: [true]
 
     runs-on: ${{ matrix.os }}
-    continue-on-error: true  # don't cancel due to OS specific failures
+    continue-on-error: false  # don't cancel due to OS specific failures
     env:
       OS: ${{ matrix.os }}
       PYTHON: ${{ matrix.python-version }}
@@ -69,9 +69,6 @@ jobs:
         pip install setuptools
         pip install .[test]
 
-    - name: Get package version
-      run: python setup.py --version
-
     - name: Run tests
       run: |
         pytest tests/ --cov=pyrekordbox --cov-report=xml -v

{pyrekordbox-0.2.2 → pyrekordbox-0.3.0}/.pre-commit-config.yaml

@@ -12,14 +12,11 @@ repos:
           - id: check-toml
           - id: check-yaml
 
-    - repo: https://github.com/psf/black
-      rev: 23.10.0
+    - repo: https://github.com/astral-sh/ruff-pre-commit
+      rev: v0.1.7
       hooks:
-        - id: black
-          args: [ --safe ]
-
-    - repo: https://github.com/PyCQA/flake8
-      rev: 6.1.0
-      hooks:
-          - id: flake8
-            additional_dependencies: [Flake8-pyproject]
+        # Run the linter.
+        - id: ruff
+          args: [ --fix ]
+        # Run the formatter.
+        - id: ruff-format

{pyrekordbox-0.2.2 → pyrekordbox-0.3.0}/CHANGELOG.md

@@ -1,5 +1,43 @@
 # What's New
 
+<a name="0.3.0"></a>
+## [0.3.0] - 2023-12-12
+
+This release fixes bugs and imrpoves error handling.
+
+### Improvements/Bug Fixes
+
+- **The `bank` field of PSSI ANLZ tag can also have a value of 0 ([#108](https://github.com/dylanljones/pyrekordbox/issues/108))**  
+  This fixes an issue where the XOR mask was applied to un-garbled PSSI tags.
+- **check if RBv6 db key seems valid ([#105](https://github.com/dylanljones/pyrekordbox/issues/105))**  
+  Check the key if it is passed manually to the db handler and raise an exception 
+  if it doesn't look valid. Only the first few characters are checked.
+- **also change `OrgFolderPath` and `FileNameL` in `update_content_path` ([#104](https://github.com/dylanljones/pyrekordbox/issues/104))**  
+  There were columns missing in the `update_content_path` method. 
+  These changes make the file paths consistent. 
+  Thank you [@ben-hearn-sb](https://github.com/ben-hearn-sb) for the help!
+- **rename the `xml` module to `rbxml` to prevent conflict with builtin.**  
+  Note that the old module name `xml` is deprecated and will be removed in version `0.4.0`.
+
+### Documentation
+
+- **add Rekordbox6 database key extraction alternatives**  
+
+
+<a name="0.2.3"></a>
+## [0.2.3] - 2023-11-17
+
+### Improvements/Bug Fixes
+
+- **drop Python 3.7 support**  
+  Python 3.7 reached its end of lifetime in June 2023.
+- **raise ImportError if RBv6 db is locked and sqlcipher is not available**  
+  Pyrekordbox falls back to `sqlite3` if `sqlcipher3` is not available.
+  This can lead to errors if the RBv6 database is locked and the user does not have 
+  `sqlcipher3` installed.
+- **don't pass deleted RBv6 instance to USN callback**  
+  This sometimes raised an `ObjectDeletedError`
+
 
 <a name="0.2.2"></a>
 ## [0.2.2] - 2023-10-26
@@ -466,7 +504,9 @@ This release contains documentation fixes.
 - **add missing djmd tables to `master.db` database documentation**
 
 
-[Unreleased]: https://github.com/dylanljones/pyrekordbox/compare/0.2.2...HEAD
+[Unreleased]: https://github.com/dylanljones/pyrekordbox/compare/0.3.0...HEAD
+[0.3.0]: https://github.com/dylanljones/pyrekordbox/compare/0.2.3...0.3.0
+[0.2.3]: https://github.com/dylanljones/pyrekordbox/compare/0.2.2...0.2.3
 [0.2.2]: https://github.com/dylanljones/pyrekordbox/compare/0.2.1...0.2.2
 [0.2.1]: https://github.com/dylanljones/pyrekordbox/compare/0.2.0...0.2.1
 [0.2.0]: https://github.com/dylanljones/pyrekordbox/compare/0.1.8...0.2.0

{pyrekordbox-0.2.2 → pyrekordbox-0.3.0}/CONTRIBUTING.md

@@ -8,9 +8,9 @@ the CI setup since it requires a working Rekordbox installation.
 
 ## Pre-commit Hooks
 
-We are using the [pre-commit framework] to automatically run  some checks and
-the [Black code formatter] at commit time. This ensures that every commit fulfills
-the basic requirements to be mergeable and follows the coding style of the project.
+We are using the [pre-commit framework] to automatically run a linter and code formatter
+at commit time. This ensures that every commit fulfills the basic requirements to be
+mergeable and follows the coding style of the project.
 
 The pre-commit hooks can be installed via
 ````sh
@@ -88,5 +88,4 @@ Similarly, a Deprecation section should start with "DEPRECATED: " followed by a
 [issue]: https://github.com/dylanljones/pyrekordbox/issues
 [pulls]: https://github.com/dylanljones/pyrekordbox/pulls
 [pre-commit framework]: https://pre-commit.com/
-[Black code formatter]: https://github.com/psf/black
 [Angular commit message]: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit-message-format

{pyrekordbox-0.2.2/pyrekordbox.egg-info → pyrekordbox-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyrekordbox
-Version: 0.2.2
+Version: 0.3.0
 Summary: Inofficial Python package for interacting with the library of Pioneers Rekordbox DJ software.
 Author-email: Dylan Jones <dylanljones94@gmail.com>
 License: MIT License
@@ -38,13 +38,13 @@ Classifier: Operating System :: MacOS
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Multimedia :: Sound/Audio
-Requires-Python: >=3.7
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: bidict>=0.21.0
@@ -70,7 +70,7 @@ Requires-Dist: pytest-cov; extra == "test"
 [![Python][python-badge+]][pypi-link]
 [![Platform][platform-badge]][pypi-link]
 [![license: MIT][license-badge]][license-link]
-[![style: black][black-badge]][black-link]
+[![style: ruff][ruff-badge]][ruff-link]
 
 > **Disclaimer**: This project is **not** affiliated with Pioneer Corp. or its related companies
 in any way and has been written independently! Pyrekordbox is licensed under the
@@ -86,8 +86,8 @@ Pioneers Rekordbox DJ Software. It currently supports
 Tested Rekordbox versions: ``5.8.6 | 6.5.3 | 6.7.7``
 
 
-|⚠️| This project is still under development and might contain bugs or have breaking API changes in the future.   |
-|----|:-------------------------------------------------------------------------------------------------------------|
+|⚠️| 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
@@ -113,7 +113,7 @@ 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 [INSTALLATION].
+For a detailed instruction, see the [installation guide][installation].
 
 #### MacOS
 
@@ -129,7 +129,8 @@ SQLCIPHER_PATH=$(brew info sqlcipher | awk 'NR==4 {print $1; exit}'); C_INCLUDE_
 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 [INSTALLATION].
+If you are having issues installing [sqlcipher3] on M1 Macs please refer to the
+[installation guide][installation].
 
 
 ## 🚀 Quick-Start
@@ -224,7 +225,7 @@ between two databases.
 Pyrekordbox can read and write Rekordbox XML databases.
 
 ````python
-from pyrekordbox.xml import RekordboxXml
+from pyrekordbox.rbxml import RekordboxXml
 
 xml = RekordboxXml("database.xml")
 
@@ -347,17 +348,20 @@ the CI setup since it requires a working Rekordbox installation.
 [tests-badge]: https://img.shields.io/github/actions/workflow/status/dylanljones/pyrekordbox/tests.yml?branch=master&label=tests&logo=github&style=flat
 [docs-badge]: https://img.shields.io/readthedocs/pyrekordbox/stable?style=flat
 [python-badge]: https://img.shields.io/pypi/pyversions/pyrekordbox?style=flat
-[python-badge+]: https://img.shields.io/badge/python-3.7+-blue.svg
+[python-badge+]: https://img.shields.io/badge/python-3.8+-blue.svg
 [platform-badge]: https://img.shields.io/badge/platform-win%20%7C%20osx-blue?style=flat
 [pypi-badge]: https://img.shields.io/pypi/v/pyrekordbox?style=flat
 [license-badge]: https://img.shields.io/pypi/l/pyrekordbox?color=lightgrey
 [black-badge]: https://img.shields.io/badge/code%20style-black-000000?style=flat
+[ruff-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
 [codecov-badge]: https://codecov.io/gh/dylanljones/pyrekordbox/branch/master/graph/badge.svg?token=5Z2KVGL7N3
 
+
 [pypi-link]: https://pypi.org/project/pyrekordbox/
 [license-link]: https://github.com/dylanljones/pyrekordbox/blob/master/LICENSE
 [tests-link]: https://github.com/dylanljones/pyrekordbox/actions/workflows/tests.yml
 [black-link]: https://github.com/psf/black
+[ruff-link]: https://github.com/astral-sh/ruff
 [lgtm-link]: https://lgtm.com/projects/g/dylanljones/pyrekordbox/context:python
 [codecov-link]: https://app.codecov.io/gh/dylanljones/pyrekordbox/tree/master
 [codecov-dev-link]: https://app.codecov.io/gh/dylanljones/pyrekordbox/tree/dev
@@ -377,7 +381,7 @@ the CI setup since it requires a working Rekordbox installation.
 [discussions]: https://github.com/dylanljones/pyrekordbox/discussions
 [CONTRIBUTING]: https://github.com/dylanljones/pyrekordbox/blob/master/CONTRIBUTING.md
 [CHANGELOG]: https://github.com/dylanljones/pyrekordbox/blob/master/CHANGELOG.md
-[INSTALLATION]: https://github.com/dylanljones/pyrekordbox/blob/master/INSTALLATION.md
+[installation]: https://pyrekordbox.readthedocs.io/en/latest/installation.html
 
 [repo]: https://github.com/dylanljones/pyrekordbox
 [sqlcipher]: https://www.zetetic.net/sqlcipher/open-source/

{pyrekordbox-0.2.2 → pyrekordbox-0.3.0}/README.md

@@ -9,7 +9,7 @@
 [![Python][python-badge+]][pypi-link]
 [![Platform][platform-badge]][pypi-link]
 [![license: MIT][license-badge]][license-link]
-[![style: black][black-badge]][black-link]
+[![style: ruff][ruff-badge]][ruff-link]
 
 > **Disclaimer**: This project is **not** affiliated with Pioneer Corp. or its related companies
 in any way and has been written independently! Pyrekordbox is licensed under the
@@ -25,8 +25,8 @@ Pioneers Rekordbox DJ Software. It currently supports
 Tested Rekordbox versions: ``5.8.6 | 6.5.3 | 6.7.7``
 
 
-|⚠️| This project is still under development and might contain bugs or have breaking API changes in the future.   |
-|----|:-------------------------------------------------------------------------------------------------------------|
+|⚠️| 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
@@ -52,7 +52,7 @@ 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 [INSTALLATION].
+For a detailed instruction, see the [installation guide][installation].
 
 #### MacOS
 
@@ -68,7 +68,8 @@ SQLCIPHER_PATH=$(brew info sqlcipher | awk 'NR==4 {print $1; exit}'); C_INCLUDE_
 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 [INSTALLATION].
+If you are having issues installing [sqlcipher3] on M1 Macs please refer to the
+[installation guide][installation].
 
 
 ## 🚀 Quick-Start
@@ -163,7 +164,7 @@ between two databases.
 Pyrekordbox can read and write Rekordbox XML databases.
 
 ````python
-from pyrekordbox.xml import RekordboxXml
+from pyrekordbox.rbxml import RekordboxXml
 
 xml = RekordboxXml("database.xml")
 
@@ -286,17 +287,20 @@ the CI setup since it requires a working Rekordbox installation.
 [tests-badge]: https://img.shields.io/github/actions/workflow/status/dylanljones/pyrekordbox/tests.yml?branch=master&label=tests&logo=github&style=flat
 [docs-badge]: https://img.shields.io/readthedocs/pyrekordbox/stable?style=flat
 [python-badge]: https://img.shields.io/pypi/pyversions/pyrekordbox?style=flat
-[python-badge+]: https://img.shields.io/badge/python-3.7+-blue.svg
+[python-badge+]: https://img.shields.io/badge/python-3.8+-blue.svg
 [platform-badge]: https://img.shields.io/badge/platform-win%20%7C%20osx-blue?style=flat
 [pypi-badge]: https://img.shields.io/pypi/v/pyrekordbox?style=flat
 [license-badge]: https://img.shields.io/pypi/l/pyrekordbox?color=lightgrey
 [black-badge]: https://img.shields.io/badge/code%20style-black-000000?style=flat
+[ruff-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
 [codecov-badge]: https://codecov.io/gh/dylanljones/pyrekordbox/branch/master/graph/badge.svg?token=5Z2KVGL7N3
 
+
 [pypi-link]: https://pypi.org/project/pyrekordbox/
 [license-link]: https://github.com/dylanljones/pyrekordbox/blob/master/LICENSE
 [tests-link]: https://github.com/dylanljones/pyrekordbox/actions/workflows/tests.yml
 [black-link]: https://github.com/psf/black
+[ruff-link]: https://github.com/astral-sh/ruff
 [lgtm-link]: https://lgtm.com/projects/g/dylanljones/pyrekordbox/context:python
 [codecov-link]: https://app.codecov.io/gh/dylanljones/pyrekordbox/tree/master
 [codecov-dev-link]: https://app.codecov.io/gh/dylanljones/pyrekordbox/tree/dev
@@ -316,7 +320,7 @@ the CI setup since it requires a working Rekordbox installation.
 [discussions]: https://github.com/dylanljones/pyrekordbox/discussions
 [CONTRIBUTING]: https://github.com/dylanljones/pyrekordbox/blob/master/CONTRIBUTING.md
 [CHANGELOG]: https://github.com/dylanljones/pyrekordbox/blob/master/CHANGELOG.md
-[INSTALLATION]: https://github.com/dylanljones/pyrekordbox/blob/master/INSTALLATION.md
+[installation]: https://pyrekordbox.readthedocs.io/en/latest/installation.html
 
 [repo]: https://github.com/dylanljones/pyrekordbox
 [sqlcipher]: https://www.zetetic.net/sqlcipher/open-source/

{pyrekordbox-0.2.2 → pyrekordbox-0.3.0}/docs/source/index.md

@@ -11,7 +11,6 @@ sphinx-quickstart on Thu Apr  7 15:06:50 2022.
 [![Python][python-badge+]][pypi-link]
 [![Platform][platform-badge]][pypi-link]
 [![license: MIT][license-badge]][license-link]
-[![style: black][black-badge]][black-link]
 
 ```{admonition} Disclaimer
 This project is not affiliated with Pioneer Corp. or its related companies
@@ -45,6 +44,7 @@ caption: User Guide
 
 quickstart
 installation
+key
 tutorial/index
 api
 ```
@@ -90,16 +90,14 @@ PyPI <https://pypi.org/project/pyrekordbox/>
 [tests-badge]: https://img.shields.io/github/actions/workflow/status/dylanljones/pyrekordbox/tests.yml?branch=master&label=tests&logo=github&style=flat
 [codecov-badge]: https://codecov.io/gh/dylanljones/pyrekordbox/branch/master/graph/badge.svg?token=5Z2KVGL7N3
 [python-badge]: https://img.shields.io/pypi/pyversions/pyrekordbox?style=flat
-[python-badge+]: https://img.shields.io/badge/python-3.7+-blue.svg
+[python-badge+]: https://img.shields.io/badge/python-3.8+-blue.svg
 [platform-badge]: https://img.shields.io/badge/platform-win%20%7C%20osx-blue?style=flat
 [pypi-badge]: https://img.shields.io/pypi/v/pyrekordbox?style=flat
 [license-badge]: https://img.shields.io/pypi/l/pyrekordbox?color=lightgrey
-[black-badge]: https://img.shields.io/badge/code%20style-black-000000?style=flat
 
 [pypi-link]: https://pypi.org/project/pyrekordbox/
 [license-link]: https://github.com/dylanljones/pyrekordbox/blob/master/LICENSE
 [tests-link]: https://github.com/dylanljones/pyrekordbox/actions/workflows/tests.yml
-[black-link]: https://github.com/psf/black
 [codecov-link]: https://app.codecov.io/gh/dylanljones/pyrekordbox/tree/master
 
 [issue]: https://github.com/dylanljones/pyrekordbox/issues/64

pyrekordbox-0.2.2/INSTALLATION.md → pyrekordbox-0.3.0/docs/source/installation.md

@@ -16,15 +16,24 @@ where `VERSION` is a branch, tag or release. The project can also be cloned/fork
 and installed via
 
 ```sh
-$ python setup.py install
+$ 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``.
+
+[sqlcipher3] can either be built with the system [SQLCipher][sqlcipher] or built against
+a statically linked amalgamation of the SQLite3 source code.
 
 ### Windows
 
+#### SQLCipher Amalagamation
+
 The easiest method to install SQLCipher on Windows is to build [sqlcipher3]
 against an amalgamation of the SQLite3 source code.
 
@@ -49,13 +58,14 @@ against an amalgamation of the SQLite3 source code.
    - 32-bit: ``C:/Program Files (x86)/openssl-Win32/bin/openssl.cfg``
    - 64-bit: ``C:/Program Files/openssl-Win64/bin/openssl.cfg``
 
+   ```{note}
    The library names of OpenSSL have changed in version 1.1.0 (see [this](https://stackoverflow.com/questions/65345077/unable-to-build-sqlcipher3-on-windows) discussion).
    If you are using a newer version, you can set an environment variable
    ``OPENSSL_LIBNAME`` to the name of the library, e.g. ``libcrypto.lib``.
    Alternatively, you can modify the ``setup.py`` script (see step 8 below).
 
    You might have to restart Windows for the changes to take effect.
-
+   ```
 
 4. **Copy the openssl folder to the Microsoft Visual Studio 14 VC include directory**
 
@@ -63,22 +73,30 @@ against an amalgamation of the SQLite3 source code.
    - 32-bit: `C:/Program Files (x86)/OpenSSL-Win32/include/openssl`
    - 64-bit: `C:/Program Files/OpenSSL-Win64/include/openssl`
 
-   The VC include directory (for any VS version) can be found in the
-   Visual Studio installation directory:
-   `C:/Program Files (x86)/Microsoft Visual Studio 14.0/VC/include`
+   The VC include directory can be found in the
+   Visual Studio 14 installation directory:
+
+   > C:/Program Files (x86)/Microsoft Visual Studio 14.0/VC/include
+
+   In newer versions it might aso be in
+
+   > C:/Program Files/Microsoft Visual Studio/2022/Community/VC/Tools/MSVC/[version]/include
 
    Confirm the following path exists `.../include/openssl/aes.h`
 
 
 5. **Download / compile the SQLCipher 3 amalgamation files**
 
-   Pre-built SQLCipher 3 amalgamation files can be downloaded from [this repo](https://github.com/geekbrother/sqlcipher-amalgamation).
-   To compile the amalgamation files, follow [this tutorial](http://www.jerryrw.com/howtocompile.php).
+   Pre-built SQLCipher amalgamation files can be downloaded from [this repo][amalgamation]:
+   ````shell
+   git clone https://github.com/geekbrother/sqlcipher-amalgamation
+   ````
+   To compile the amalgamation files on your own, follow [this tutorial](http://www.jerryrw.com/howtocompile.php).
 
 
 6. **Clone [sqlcipher3] into any directory**
 
-   ````commandline
+   ````shell
    git clone https://github.com/coleifer/sqlcipher3
    ````
 
@@ -87,6 +105,10 @@ against an amalgamation of the SQLite3 source code.
 
    Copy files ``sqlite3.c`` and ``sqlite3.h`` from the amalgamation directory from step 5
    to the root of the ``sqlcipher3`` directory from step 6.
+   ````shell
+   Copy-Item -Path 'sqlcipher-amalgamation/src/sqlite3.c' -Destination "sqlcipher3/"
+   Copy-Item -Path 'sqlcipher-amalgamation/src/sqlite3.h' -Destination "sqlcipher3/"
+   ````
 
 
 8. **Modify the ``sqlcipher3/setup.py`` script (optional)**
@@ -102,42 +124,36 @@ against an amalgamation of the SQLite3 source code.
    ````
 
 
-9. **Build using the amalgamation**
+9. **Build using the amalgamation and install**
 
     ``cd`` into the ``sqlcipher3`` directory and run
-    ````commandline
+    ````shell
     python setup.py build_static build
-    ````
-
-
-10. **Install ``sqlcipher3``**
-
-    ````commandline
     python setup.py install
     ````
 
+
 You now should have a working ``sqlcipher3`` installation! The directory of the
 cloned ``sqlcipher3`` repo can be deleted after installing the package.
 
-Steps 5-10 can be automated using the CLI of ``pyrekordbox``:
-````commandline
-> python3 -m pyrekordbox install-sqlcipher --help
-usage: pyrekordbox install-sqlcipher [-h] [-t TMPDIR] [-l CRYPTOLIB] [-q] [-b]
-
-  -h, --help            show this help message and exit
-  -t TMPDIR, --tmpdir TMPDIR
-                        Path for storing temporary data (default: '.tmp')
-  -l CRYPTOLIB, --cryptolib CRYPTOLIB
-                        The name of the OpenSSl crypto libary (default: 'libcrypto.lib')
-  -b, --buildonly       Don't install sqlcipher3, only build the amalgamation
-````
+Steps 5-9 can be automated using the CLI of ``pyrekordbox``:
+
+    > python3 -m pyrekordbox install-sqlcipher --help
+    usage: pyrekordbox install-sqlcipher [-h] [-t TMPDIR] [-l CRYPTOLIB] [-q] [-b]
 
-#### Troubleshooting
+      -t TMPDIR, --tmpdir TMPDIR
+                            Path for storing temporary data (default: '.tmp')
+      -l CRYPTOLIB, --cryptolib CRYPTOLIB
+                            The name of the OpenSSl crypto libary (default: 'libcrypto.lib')
+      -b, --buildonly       Don't install sqlcipher3, only build the amalgamation
+
+
+##### Troubleshooting
 
 - **Microsoft Visual C++ error**
 
   If you are getting an error like
-  ````commandline
+  ````shell
   error: Microsoft Visual C++ 14.0 or greater is required. Get it with "Microsoft C++ Build Tools"``
   ````
   and have Visual Studio installed, you might not have all the necessary C/C++ components.
@@ -145,11 +161,11 @@ usage: pyrekordbox install-sqlcipher [-h] [-t TMPDIR] [-l CRYPTOLIB] [-q] [-b]
 - **LINK error**
 
   If you are getting an error like
-  ````commandline
+  ````shell
   LINK : fatal error LNK1158: cannot run 'rc.exe'
   ````
   or
-  ````commandline
+  ````shell
   LINK : fatal error LNK1327: failure during running rc.exe
   ````
   make sure all the necessary C/C++ components are installed and that you have selected
@@ -159,7 +175,10 @@ usage: pyrekordbox install-sqlcipher [-h] [-t TMPDIR] [-l CRYPTOLIB] [-q] [-b]
 
 ### MacOS
 
-For MacOS follow these steps:
+
+#### System SQLCipher
+
+For building [sqlcipher3] against the system SQLCipher installation on 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`.
@@ -172,15 +191,65 @@ SQLCIPHER_PATH=$(brew info sqlcipher | awk 'NR==4 {print $1; exit}'); C_INCLUDE_
 ```
 Make sure the `C_INCLUDE` and `LIBRARY_PATH` point to the installed SQLCipher path. It may differ on your machine.
 
+````{note}
 If you are having issues building sqlcipher on M1 Macs you might have to add some symlinks:
 ```shell
 ln -s /opt/homebrew/lib/libsqlcipher.a /usr/local/lib/libsqlcipher.a
 ln -s /opt/homebrew/include/sqlcipher /usr/local/include/sqlcipher
 ```
-Alternatively, you can also build [sqlcipher3] against an amalgamation (as described above for Windows, steps 5-10).
+````
+#### SQLCipher Amalagamation
+
+You can also build [sqlcipher3] against an amalgamation on MacOS.
+
+1. **Download / compile the SQLCipher amalgamation files**
+
+   Pre-built SQLCipher amalgamation files can be downloaded from [this repo][amalgamation]:
+   ````shell
+   git clone https://github.com/geekbrother/sqlcipher-amalgamation
+   ````
+   You can also build the amalagamtion files on your own.
 
 
-## Using SQLCipher
+2. **Clone [sqlcipher3] into any directory**
+
+   ````shell
+   git clone https://github.com/coleifer/sqlcipher3
+   ````
+
+
+3. **Copy amalgamation files to the `sqlcipher3` directory**
+
+   Copy files ``sqlite3.c`` and ``sqlite3.h`` from the amalgamation directory from step 1
+   to the root of the ``sqlcipher3`` directory from step 2.
+   ````shell
+   cp sqlcipher-amalgamation/src/sqlite3.[ch] sqlcipher3/
+   ````
+
+4. **Build using the amalgamation and install**
+
+    ``cd`` into the ``sqlcipher3`` directory and run
+    ````shell
+    python setup.py build_static build
+    python setup.py install
+    ````
+
+The steps above can be automated using the CLI of ``pyrekordbox``
+
+    > python3 -m pyrekordbox install-sqlcipher --help
+    usage: pyrekordbox install-sqlcipher [-h] [-t TMPDIR] [-l CRYPTOLIB] [-q] [-b]
+
+      -t TMPDIR, --tmpdir TMPDIR
+                            Path for storing temporary data (default: '.tmp')
+      -b, --buildonly       Don't install sqlcipher3, only build the amalgamation
+
+
+```{note}
+The `CRYPTOLIB` argument is only used on Windows
+```
+
+
+### Using SQLCipher
 
 After the installation SQLCipher-databases can be unlocked via the `sqlcipher3` package:
 ````python
@@ -192,16 +261,11 @@ c.execute("PRAGMA key='password'")
 ````
 
 
-### References:
-
-- [https://stackoverflow.com/questions/33618565/how-to-build-sql-cipher-python-binding-for-windows](https://stackoverflow.com/questions/33618565/how-to-build-sql-cipher-python-binding-for-windows)
-- [https://github.com/Monogi/pysqlcipher3_install_win10](https://github.com/Monogi/pysqlcipher3_install_win10)
-
-
 
 [VS]: https://visualstudio.microsoft.com/de/vs/community/
 [OpenSSL]: https://slproweb.com/products/Win32OpenSSL.html
 [sqlcipher3]: https://github.com/coleifer/sqlcipher3
+[amalgamation]: https://github.com/geekbrother/sqlcipher-amalgamation
 [Pypi]: https://pypi.org/project/pyrekordbox/
 [GitHub]: https://github.com/dylanljones/pyrekordbox
 [sqlcipher]: https://www.zetetic.net/sqlcipher/open-source/