pyrekordbox 0.2.1__py3-none-any.whl → 0.2.2__py3-none-any.whl

build/lib/docs/source/conf.py

@@ -1,178 +0,0 @@
-# Configuration file for the Sphinx documentation builder.
-#
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-
-# -- Path setup --------------------------------------------------------------
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-import os
-import sys
-
-sys.path.insert(0, os.path.abspath("../.."))
-
-import pyrekordbox
-
-
-# -- Project information -----------------------------------------------------
-
-project = "pyrekordbox"
-copyright = "2022-2023, Dylan Jones"
-author = "Dylan L. Jones"
-release = pyrekordbox.__version__
-version = release
-for sp in "abcfr":
-    version = version.split(sp)[0]
-
-# -- General configuration ---------------------------------------------------
-
-# If your documentation needs a minimal Sphinx version, state it here.
-needs_sphinx = "4.4"
-
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = [
-    "sphinx.ext.autodoc",
-    "numpydoc",
-    "myst_parser",
-    "numpydoc",
-    "sphinx_copybutton",
-    "sphinx.ext.napoleon",
-    "sphinx.ext.autosummary",
-    "sphinx.ext.autosectionlabel",
-    "matplotlib.sphinxext.plot_directive",
-    "sphinx.ext.intersphinx",  # links to numpy, scipy ... docs
-    "sphinx.ext.coverage",
-    "sphinx.ext.extlinks",  # define roles for links
-    "sphinx.ext.viewcode",
-]
-
-# If you need extensions of a certain version or higher, list them here.
-needs_extensions = {"myst_parser": "0.13.7"}
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ["_templates"]
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
-
-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "tests"]
-
-# The suffix(es) of source filenames.
-# You can specify multiple suffix as a list of string:
-source_suffix = [".rst", ".md"]
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
-
-html_theme_options = {
-    "light_logo": "logos/dark/logo_primary.svg",
-    "dark_logo": "logos/light/logo_primary.svg",
-    "sidebar_hide_name": True,
-    "footer_icons": [
-        {
-            "name": "GitHub",
-            "url": "https://github.com/dylanljones/pyrekordbox",
-            "html": """
-                <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
-                    <path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
-                </svg>
-            """,
-            "class": "",
-        },
-    ],
-}
-
-# html_title = f"{release} documentation"
-
-# -- Options for HTML output -------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-html_theme = "furo"
-
-# The name of the Pygments (syntax highlighting) style to use.
-# pygments_style = "sphinx"
-# pygments_dark_style = "monokai"
-
-# We need headers to be linkable to so ask MyST-Parser to autogenerate anchor IDs for
-# headers up to and including level 3.
-myst_heading_anchors = 3
-
-# Prettier support formatting some MyST syntax but not all, so let's disable the
-# unsupported yet still enabled by default ones.
-myst_disable_syntax = [
-    "colon_fence",
-    "myst_block_break",
-    "myst_line_comment",
-    "math_block",
-]
-
-
-# Don't show type hints
-autodoc_typehints = "none"
-
-# Preserve order
-autodoc_member_order = "bysource"
-
-
-# -- Apidoc ------------------------------------------------------------------
-
-add_module_names = True
-
-
-# -- Autosummary -------------------------------------------------------------
-
-autosummary_generate = True
-# autosummary_imported_members = True
-
-
-# -- Numpy extension ---------------------------------------------------------
-
-numpydoc_use_plots = True
-# numpydoc_xref_param_type = True
-# numpydoc_xref_ignore = "all"  # not working...
-numpydoc_show_class_members = False
-
-
-# -- Intersphinx -------------------------------------------------------------
-
-# taken from https://gist.github.com/bskinn/0e164963428d4b51017cebdb6cda5209
-intersphinx_mapping = {
-    "python": (r"https://docs.python.org", None),
-    "numpy": (r"https://docs.scipy.org/doc/numpy/", None),
-    "np": (r"https://docs.scipy.org/doc/numpy/", None),
-    "matplotlib": (r"https://matplotlib.org/", None),
-    "<name>": ("https://docs.python.org/3/", None),
-}
-
-
-# -- Auto-run sphinx-apidoc --------------------------------------------------
-
-
-def run_apidoc(_):
-    from sphinx.ext.apidoc import main
-    import os
-    import sys
-
-    sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
-    cur_dir = os.path.abspath(os.path.dirname(__file__))
-    proj_dir = os.path.dirname(os.path.dirname(cur_dir))
-    doc_dir = os.path.join(proj_dir, "docs")
-    output_path = os.path.join(doc_dir, "source", "generated")
-    module = os.path.join(proj_dir, "pyrekordbox")
-    exclude = os.path.join(module, "tests")
-    template_dir = os.path.join(doc_dir, "source", "_templates", "apidoc")
-    main(["-fMeT", "-o", output_path, module, exclude, "--templatedir", template_dir])
-
-
-def setup(app):
-    app.connect("builder-inited", run_apidoc)

build/lib/pyrekordbox/__init__.py

@@ -1,22 +0,0 @@
-# -*- coding: utf-8 -*-
-# Author: Dylan Jones
-# Date:   2022-04-10
-
-from .logger import logger
-from .config import show_config, get_config
-from .xml import RekordboxXml, XmlDuplicateError, XmlAttributeKeyError
-from .anlz import get_anlz_paths, walk_anlz_paths, read_anlz_files, AnlzFile
-from .mysettings import (
-    get_mysetting_paths,
-    read_mysetting_file,
-    MySettingFile,
-    MySetting2File,
-    DjmMySettingFile,
-    DevSettingFile,
-)
-from .db6 import Rekordbox6Database, open_rekordbox_database
-
-try:
-    from ._version import version as __version__
-except ImportError:  # pragma: no cover
-    __version__ = "unknown"

build/lib/pyrekordbox/__main__.py

@@ -1,204 +0,0 @@
-# -*- coding: utf-8 -*-
-# Author: Dylan Jones
-# Date:   2023-08-15
-
-import os
-import re
-import sys
-import shutil
-import urllib.request
-from pathlib import Path
-from pyrekordbox.config import write_db6_key_cache, _cache_file
-
-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):
-        self._prev = Path.cwd()
-        self.path = Path(path)
-
-    def __enter__(self):
-        if self.path != self._prev:
-            self.path.mkdir(parents=True, exist_ok=True)
-            os.chdir(self.path)
-
-    def __exit__(self, exc_type, exc_val, exc_tb):
-        if self.path != self._prev:
-            os.chdir(self._prev)
-
-
-def clone_repo(https_url: str) -> Path:
-    path = Path.cwd() / https_url.split("/")[-1]
-    if not path.exists():
-        os.system(f"git clone {https_url}")
-        assert path.exists()
-    else:
-        print(f"Repository {https_url} already cloned")
-    return path
-
-
-def clone_pysqlcipher3() -> Path:
-    return clone_repo(r"https://github.com/coleifer/sqlcipher3")
-
-
-def clone_sqlcipher_amalgamation() -> Path:
-    return clone_repo(r"https://github.com/geekbrother/sqlcipher-amalgamation")
-
-
-def patch_pysqlcipher_setup(pysqlcipher_dir, cryptolib="libcrypto.lib"):
-    path = Path(pysqlcipher_dir, "setup.py")
-
-    with open(path, "r") as fh:
-        text = fh.read()
-
-    if cryptolib:
-        lib_old = "os.environ.get('OPENSSL_LIBNAME') or 'libeay32.lib'"
-        lib_new = f"os.environ.get('OPENSSL_LIBNAME') or '{cryptolib}'"
-        text = text.replace(lib_old, lib_new)
-
-    with open(path, "w") as fh:
-        fh.write(text)
-
-
-def prepare_pysqlcipher(pysqlcipher_dir: Path, amalgamation_src: Path):
-    # Copy amalgamation files to pysqlcipher directory
-    root = pysqlcipher_dir
-    root.mkdir(parents=True, exist_ok=True)
-    shutil.copy2(amalgamation_src / "sqlite3.c", root / "sqlite3.c")
-    shutil.copy2(amalgamation_src / "sqlite3.h", root / "sqlite3.h")
-
-
-def install_pysqlcipher(
-    tmpdir="pysqlcipher3",
-    crypto_lib="libcrypto.lib",
-    pyexecutable="",
-    build=True,
-    install=True,
-    cleanup=True,
-):
-    if sys.platform != "win32":
-        print("Not on Windows, aborting...")
-        return
-
-    tmpdir = Path(tmpdir)
-    # Download pysqlcipher3 and prepare amalgamation build
-    with WorkingDir(tmpdir):
-        pysqlcipher_dir = clone_pysqlcipher3()
-        amalgamation_dir = clone_sqlcipher_amalgamation()
-        amalgamation_src = amalgamation_dir / "src"
-
-        prepare_pysqlcipher(pysqlcipher_dir, amalgamation_src)
-        if os.getenv("OPENSSL_LIBNAME") is None:
-            print("No OPENSSL_LIBNAME environment variable found, updating `setup.py`!")
-            patch_pysqlcipher_setup(pysqlcipher_dir, crypto_lib)
-
-    # Build amalgamation and install pysqlcipher
-    if not pyexecutable:
-        pyexecutable = sys.executable
-
-    with WorkingDir(pysqlcipher_dir):
-        if build:
-            # Build amalgamation
-            print()
-            os.system(f"{pyexecutable} setup.py build_static build")
-        if install:
-            # Install pysqlcipher package
-            print()
-            os.system(f"{pyexecutable} setup.py install")
-
-    # Remove temporary files
-    if cleanup:
-        try:
-            print()
-            print("Cleaning up")
-            tmpdir.unlink(missing_ok=True)
-        except PermissionError as e:
-            print()
-            print(e)
-            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:
-        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",
-        help="Build sqlcipher against amalgamation and install pysqlcipher3",
-    )
-    install_parser.add_argument(
-        "-t",
-        "--tmpdir",
-        type=str,
-        default=".tmp",
-        help="Path for storing temporary data (default: '.tmp')",
-    )
-    install_parser.add_argument(
-        "-l",
-        "--cryptolib",
-        type=str,
-        default="libcrypto.lib",
-        help="The name of the OpenSSl crypto libary (default: 'libcrypto.lib')",
-    )
-    install_parser.add_argument(
-        "-b",
-        "--buildonly",
-        action="store_true",
-        help="Don't install sqlcipher3, only build the amalgamation",
-    )
-
-    # 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":
-        install_pysqlcipher(args.tmpdir, args.cryptolib, install=not args.buildonly)
-
-
-if __name__ == "__main__":
-    main()

build/lib/pyrekordbox/_version.py

@@ -1,16 +0,0 @@
-# file generated by setuptools_scm
-# don't change, don't track in version control
-TYPE_CHECKING = False
-if TYPE_CHECKING:
-    from typing import Tuple, Union
-    VERSION_TUPLE = Tuple[Union[int, str], ...]
-else:
-    VERSION_TUPLE = object
-
-version: str
-__version__: str
-__version_tuple__: VERSION_TUPLE
-version_tuple: VERSION_TUPLE
-
-__version__ = version = '0.2.1'
-__version_tuple__ = version_tuple = (0, 2, 1)

build/lib/pyrekordbox/anlz/__init__.py

@@ -1,127 +0,0 @@
-# -*- coding: utf-8 -*-
-# Author: Dylan Jones
-# Date:   2023-02-01
-
-import re
-from pathlib import Path
-from typing import Union
-from . import structs
-from .file import AnlzFile
-
-RE_ANLZ = re.compile("ANLZ[0-9]{4}.(DAT|EXT|2EX)")
-
-
-def is_anlz_file(path: Union[str, Path]) -> bool:
-    """Checks if the name of a file matches the ANLZ file name pattern.
-
-    Parameters
-    ----------
-    path : str or Path
-        The file path to check
-
-    Returns
-    -------
-    is_anlz : bool
-        True if the file is an ANLZ file.
-
-    Examples
-    --------
-    >>> is_anlz_file("ANLZ0000.DAT")
-    True
-
-    >>> is_anlz_file("/path/to/ANLZ0000.DAT")
-    False
-
-    >>> is_anlz_file("ANLZ.DAT")
-    False
-    """
-    path = Path(path)
-    if not path.exists() or not path.is_file():
-        return False
-    return bool(RE_ANLZ.match(path.name))
-
-
-def get_anlz_paths(root: Union[str, Path]) -> dict:
-    """Returns the paths of all existing ANLZ files in a directory.
-
-    Parameters
-    ----------
-    root : str or Path
-        The path of the directory containing ANLZ files.
-
-    Returns
-    -------
-    anlz_paths : dict[str, Path]
-        The file paths stored as dictionary with the type of ANLZ file as keys
-        ("DAT", "EXT", "EX2")
-
-    Examples
-    --------
-    >>> p = get_anlz_paths("directory/")
-    >>> p["DAT"]
-    directory/ANLZ0000.DAT
-    """
-    paths = {"DAT": None, "EXT": None, "2EX": None}
-    for path in Path(root).iterdir():
-        if RE_ANLZ.match(path.name):
-            paths[path.suffix[1:].upper()] = path
-    return paths
-
-
-def walk_anlz_dirs(root_dir: Union[str, Path]):
-    """Finds all ANLZ directory paths recursively.
-
-    Parameters
-    ----------
-    root_dir : str or Path
-        The path of the root directory.
-
-    Yields
-    -------
-    anlz_dir : str
-        The path of a directory containing ANLZ files
-    """
-    for path in Path(root_dir).rglob("*"):
-        if path.is_dir():
-            if any(is_anlz_file(f) for f in path.iterdir()):
-                yield path
-
-
-def walk_anlz_paths(root_dir: Union[str, Path]):
-    """Finds all ANLZ directory paths and the containing file paths recursively.
-
-    Parameters
-    ----------
-    root_dir : str or Path
-        The path of the root directory.
-
-    Yields
-    -------
-    anlz_dir : str
-        The path of a directory containing ANLZ files.
-    anlz_files : Sequence of str
-        The file paths of the ANLZ files in `anlz_dir`.
-    """
-    root_dir = Path(root_dir)
-    assert root_dir.exists()
-    for anlz_dir in walk_anlz_dirs(root_dir):
-        files = {k: path for k, path in get_anlz_paths(anlz_dir).items() if path}
-        yield anlz_dir, files
-
-
-def read_anlz_files(root: Union[str, Path] = "") -> dict:
-    """Open all ANLZ files in the given root directory.
-
-    Parameters
-    ----------
-    root : str or Path, optional
-        The root directory of the ANLZ files to open.
-
-    Returns
-    -------
-    anlz_files : dict
-        The opened ANLZ files stored in a dict with the corresponding file paths
-        as keys.
-    """
-    paths = get_anlz_paths(root)
-    return {path: AnlzFile.parse_file(path) for path in paths.values() if path}