syncfm-core 0.2.4__tar.gz → 0.3.0__tar.gz

{syncfm_core-0.2.4 → syncfm_core-0.3.0}/PKG-INFO

@@ -1,24 +1,24 @@
 Metadata-Version: 2.4
 Name: syncfm-core
-Version: 0.2.4
-Summary: Reusable synchronization engine and CLI for Last.fm, Libre.fm and GNU.fm networks.
-Keywords: lastfm,librefm,gnufm,scrobble,music
+Version: 0.3.0
+Summary: Reusable synchronization engine and CLI for Last.fm, Libre.fm and LoneFM networks.
+Keywords: lastfm,librefm,lonefm,scrobble,music
 Author: Hirad
 Author-email: Hirad <hirad@hirad.it>
 License-Expression: GPL-3.0-or-later
 License-File: LICENSE
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Operating System :: OS Independent
 Requires-Dist: keyring>=25.7.0
 Requires-Dist: platformdirs>=4.11.1
-Requires-Dist: pylast>=7.1.0
+Requires-Dist: pyscrobbler>=0.1.5
 Requires-Dist: rich>=15.0.0
 Requires-Dist: socksio>=1.0.0
 Requires-Dist: tomlkit>=0.15.1
 Requires-Dist: typer>=0.27.1
-Requires-Python: >=3.12
+Requires-Python: >=3.13
 Project-URL: Homepage, https://git.hirad.it/Hirad/syncfm-core
 Project-URL: Documentation, https://git.hirad.it/Hirad/syncfm-core/wiki
 Project-URL: Repository, https://git.hirad.it/Hirad/syncfm-core
@@ -28,7 +28,7 @@ Description-Content-Type: text/markdown
 # syncfm-core
 
 `syncfm-core` synchronizes missing scrobbles between Last.fm, Libre.fm, and
-GNU.fm-compatible networks. It includes both a reusable, typed Python
+LoneFM-compatible networks. It includes both a reusable, typed Python
 application layer and the `syncfm` command-line interface.
 
 The project is currently beta software. Keep a copy of important listening
@@ -37,7 +37,7 @@ history before using it with an account you cannot easily restore.
 ## Features
 
 - Directional synchronization from a source profile to a target profile
-- Last.fm, Libre.fm, and custom GNU.fm-compatible instances
+- Last.fm, Libre.fm, and custom LoneFM-compatible instances
 - Optional start and end timestamps for bounded synchronization
 - Durable SQLite sessions that can be inspected, resumed, or discarded
 - Metadata enrichment and retries for transient network failures
@@ -48,7 +48,7 @@ history before using it with an account you cannot easily restore.
 
 ## Requirements
 
-- Python 3.12 or newer
+- Python 3.13 or newer
 - API credentials for every configured network
 - A working system keyring when using the default credential storage
 - [`uv`](https://docs.astral.sh/uv/) for the development workflow shown below
@@ -78,9 +78,7 @@ checkout instead of an installed tool.
 
 ### 1. Create network profiles
 
-Create one profile for each account. Profile names must start with a lowercase
-letter or number and may contain lowercase letters, numbers, underscores, and
-hyphens.
+Create one profile for each account. 
 
 ```console
 syncfm profile add lastfm-main \
@@ -99,11 +97,11 @@ syncfm profile add librefm-main \
   --api-key YOUR_LIBREFM_API_KEY
 ```
 
-GNU.fm profiles also require the instance hostname:
+LoneFM profiles also require the instance hostname:
 
 ```console
 syncfm profile add community \
-  --type gnufm \
+  --type lonefm \
   --hostname music.example.org \
   --username alice \
   --api-key YOUR_API_KEY
@@ -238,6 +236,7 @@ The CLI is a frontend for the same public application services available to
 Python callers:
 
 ```python
+from contextlib import ExitStack, closing
 from pathlib import Path
 
 from syncfm_core import (
@@ -250,17 +249,22 @@ from syncfm_core import (
 profiles = create_profile_service()
 factory = NetworkFactory()
 
-source = factory.create(profiles.resolve("lastfm-main"))
-target = factory.create(profiles.resolve("librefm-main"))
-
-service = create_sync_service(Path("syncfm.sqlite3"))
-result = service.sync(
-    source,
-    target,
-    SyncRequest(start_timestamp=1704067200),
-    source_profile="lastfm-main",
-    target_profile="librefm-main",
-)
+with ExitStack() as stack:
+    source = stack.enter_context(
+        closing(factory.create(profiles.resolve("lastfm-main")))
+    )
+    target = stack.enter_context(
+        closing(factory.create(profiles.resolve("librefm-main")))
+    )
+
+    service = create_sync_service(Path("syncfm.sqlite3"))
+    result = service.sync(
+        source,
+        target,
+        SyncRequest(start_timestamp=1704067200),
+        source_profile="lastfm-main",
+        target_profile="librefm-main",
+    )
 
 print(f"Synchronized {result.synced_count} scrobbles")
 print(f"Failed: {result.failed_count}")
@@ -270,6 +274,21 @@ print(f"Failed: {result.failed_count}")
 The package also exports its domain models, network protocols, profile service,
 and structured exception hierarchy for custom frontends and integrations.
 
+### Migrating from pylast
+
+NetworkFactory now returns a PyScrobblerNetworkAdapter. Python callers should
+close adapters when finished, as shown above. The MusicNetwork protocol and
+syncfm's scrobble models remain the application interface.
+
+The integration exports GNUFMNetwork, PyLastMapper, and PyLastNetworkAdapter
+and their modules have been removed. Replace direct usage with NetworkFactory
+and PyScrobblerNetworkAdapter from syncfm_core.networks.
+
+Use NetworkType.LONEFM and `--type lonefm` for custom instances. The former
+NetworkType.GNUFM enum member has been removed. Existing profiles with the
+legacy type value and saved sessions with the former display name remain
+readable; new profiles and sessions use LoneFM naming.
+
 ## Command reference
 
 ```text
@@ -293,7 +312,9 @@ Create the environment and run the project checks:
 ```console
 uv sync
 uv run ruff check .
+uv run ruff format --check .
 uv run pyright
+uv run pytest
 uv build
 ```
 

{syncfm_core-0.2.4 → syncfm_core-0.3.0}/README.md

@@ -1,7 +1,7 @@
 # syncfm-core
 
 `syncfm-core` synchronizes missing scrobbles between Last.fm, Libre.fm, and
-GNU.fm-compatible networks. It includes both a reusable, typed Python
+LoneFM-compatible networks. It includes both a reusable, typed Python
 application layer and the `syncfm` command-line interface.
 
 The project is currently beta software. Keep a copy of important listening
@@ -10,7 +10,7 @@ history before using it with an account you cannot easily restore.
 ## Features
 
 - Directional synchronization from a source profile to a target profile
-- Last.fm, Libre.fm, and custom GNU.fm-compatible instances
+- Last.fm, Libre.fm, and custom LoneFM-compatible instances
 - Optional start and end timestamps for bounded synchronization
 - Durable SQLite sessions that can be inspected, resumed, or discarded
 - Metadata enrichment and retries for transient network failures
@@ -21,7 +21,7 @@ history before using it with an account you cannot easily restore.
 
 ## Requirements
 
-- Python 3.12 or newer
+- Python 3.13 or newer
 - API credentials for every configured network
 - A working system keyring when using the default credential storage
 - [`uv`](https://docs.astral.sh/uv/) for the development workflow shown below
@@ -51,9 +51,7 @@ checkout instead of an installed tool.
 
 ### 1. Create network profiles
 
-Create one profile for each account. Profile names must start with a lowercase
-letter or number and may contain lowercase letters, numbers, underscores, and
-hyphens.
+Create one profile for each account. 
 
 ```console
 syncfm profile add lastfm-main \
@@ -72,11 +70,11 @@ syncfm profile add librefm-main \
   --api-key YOUR_LIBREFM_API_KEY
 ```
 
-GNU.fm profiles also require the instance hostname:
+LoneFM profiles also require the instance hostname:
 
 ```console
 syncfm profile add community \
-  --type gnufm \
+  --type lonefm \
   --hostname music.example.org \
   --username alice \
   --api-key YOUR_API_KEY
@@ -211,6 +209,7 @@ The CLI is a frontend for the same public application services available to
 Python callers:
 
 ```python
+from contextlib import ExitStack, closing
 from pathlib import Path
 
 from syncfm_core import (
@@ -223,17 +222,22 @@ from syncfm_core import (
 profiles = create_profile_service()
 factory = NetworkFactory()
 
-source = factory.create(profiles.resolve("lastfm-main"))
-target = factory.create(profiles.resolve("librefm-main"))
-
-service = create_sync_service(Path("syncfm.sqlite3"))
-result = service.sync(
-    source,
-    target,
-    SyncRequest(start_timestamp=1704067200),
-    source_profile="lastfm-main",
-    target_profile="librefm-main",
-)
+with ExitStack() as stack:
+    source = stack.enter_context(
+        closing(factory.create(profiles.resolve("lastfm-main")))
+    )
+    target = stack.enter_context(
+        closing(factory.create(profiles.resolve("librefm-main")))
+    )
+
+    service = create_sync_service(Path("syncfm.sqlite3"))
+    result = service.sync(
+        source,
+        target,
+        SyncRequest(start_timestamp=1704067200),
+        source_profile="lastfm-main",
+        target_profile="librefm-main",
+    )
 
 print(f"Synchronized {result.synced_count} scrobbles")
 print(f"Failed: {result.failed_count}")
@@ -243,6 +247,21 @@ print(f"Failed: {result.failed_count}")
 The package also exports its domain models, network protocols, profile service,
 and structured exception hierarchy for custom frontends and integrations.
 
+### Migrating from pylast
+
+NetworkFactory now returns a PyScrobblerNetworkAdapter. Python callers should
+close adapters when finished, as shown above. The MusicNetwork protocol and
+syncfm's scrobble models remain the application interface.
+
+The integration exports GNUFMNetwork, PyLastMapper, and PyLastNetworkAdapter
+and their modules have been removed. Replace direct usage with NetworkFactory
+and PyScrobblerNetworkAdapter from syncfm_core.networks.
+
+Use NetworkType.LONEFM and `--type lonefm` for custom instances. The former
+NetworkType.GNUFM enum member has been removed. Existing profiles with the
+legacy type value and saved sessions with the former display name remain
+readable; new profiles and sessions use LoneFM naming.
+
 ## Command reference
 
 ```text
@@ -266,7 +285,9 @@ Create the environment and run the project checks:
 ```console
 uv sync
 uv run ruff check .
+uv run ruff format --check .
 uv run pyright
+uv run pytest
 uv build
 ```
 

{syncfm_core-0.2.4 → syncfm_core-0.3.0}/pyproject.toml

@@ -1,28 +1,28 @@
 [project]
 name = "syncfm-core"
-version = "0.2.4"
-description = "Reusable synchronization engine and CLI for Last.fm, Libre.fm and GNU.fm networks."
+version = "0.3.0"
+description = "Reusable synchronization engine and CLI for Last.fm, Libre.fm and LoneFM networks."
 readme = "README.md"
 license = "GPL-3.0-or-later"
 license-files = ["LICENSE"]
 keywords = [
     "lastfm",
     "librefm",
-    "gnufm",
+    "lonefm",
     "scrobble",
     "music",
 ]
 classifiers = [
     "Development Status :: 4 - Beta",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Operating System :: OS Independent",
 ]
-requires-python = ">=3.12"
+requires-python = ">=3.13"
 dependencies = [
     "keyring>=25.7.0",
     "platformdirs>=4.11.1",
-    "pylast>=7.1.0",
+    "pyscrobbler>=0.1.5",
     "rich>=15.0.0",
     "socksio>=1.0.0",
     "tomlkit>=0.15.1",
@@ -49,17 +49,18 @@ build-backend = "uv_build"
 [dependency-groups]
 dev = [
     "pyright>=1.1.411",
+    "pytest>=9.1.1",
     "ruff>=0.16.2",
 ]
 
 [tool.pyright]
-pythonVersion = "3.12"
+pythonVersion = "3.13"
 typeCheckingMode = "strict"
 venvPath = "."
 venv = ".venv"
 
 [tool.ruff]
-target-version = "py312"
+target-version = "py313"
 line-length = 88
 indent-width = 4
 

{syncfm_core-0.2.4 → syncfm_core-0.3.0}/pyproject.toml.orig

@@ -1,25 +1,25 @@
 [project]
 name = "syncfm-core"
-version = "0.2.4"
-description = "Reusable synchronization engine and CLI for Last.fm, Libre.fm and GNU.fm networks."
+version = "0.3.0"
+description = "Reusable synchronization engine and CLI for Last.fm, Libre.fm and LoneFM networks."
 readme = "README.md"
 license = "GPL-3.0-or-later"
 license-files = ["LICENSE"]
 authors = [
     { name = "Hirad", email = "hirad@hirad.it" }
 ]
-keywords = ["lastfm", "librefm", "gnufm", "scrobble", "music"]
+keywords = ["lastfm", "librefm", "lonefm", "scrobble", "music"]
 classifiers = [
     "Development Status :: 4 - Beta",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Operating System :: OS Independent",
 ]
-requires-python = ">=3.12"
+requires-python = ">=3.13"
 dependencies = [
     "keyring>=25.7.0",
     "platformdirs>=4.11.1",
-    "pylast>=7.1.0",
+    "pyscrobbler>=0.1.5",
     "rich>=15.0.0",
     "socksio>=1.0.0",
     "tomlkit>=0.15.1",
@@ -42,17 +42,18 @@ build-backend = "uv_build"
 [dependency-groups]
 dev = [
     "pyright>=1.1.411",
+    "pytest>=9.1.1",
     "ruff>=0.16.2",
 ]
 
 [tool.pyright]
-pythonVersion = "3.12"
+pythonVersion = "3.13"
 typeCheckingMode = "strict"
 venvPath = "."
 venv = ".venv"
 
 [tool.ruff]
-target-version = "py312"
+target-version = "py313"
 line-length = 88
 indent-width = 4
 

{syncfm_core-0.2.4 → syncfm_core-0.3.0}/src/syncfm_core/cli/app.py

@@ -25,7 +25,7 @@ DEFAULT_PROFILE_PATH = default_profile_path()
 
 app = typer.Typer(
     name="syncfm",
-    help="Synchronize scrobbles between Last.fm, Libre.fm and GNU.fm networks.",
+    help="Synchronize scrobbles between Last.fm, Libre.fm and LoneFM networks.",
     no_args_is_help=True,
     rich_markup_mode="rich",
     context_settings={

syncfm_core-0.3.0/src/syncfm_core/cli/commands/common.py

@@ -0,0 +1,60 @@
+"""Shared helpers for network-based CLI commands."""
+
+from collections.abc import Generator
+from contextlib import ExitStack, contextmanager
+from functools import partial
+
+from syncfm_core.cli.context import CLIContext, run_core_operation
+from syncfm_core.networks.factory import NetworkFactory
+from syncfm_core.networks.pyscrobbler_adapter import PyScrobblerNetworkAdapter
+from syncfm_core.profiles import create_profile_service
+
+
+@contextmanager
+def create_network_pair(
+    context: CLIContext,
+    source_profile: str,
+    target_profile: str,
+) -> Generator[tuple[PyScrobblerNetworkAdapter, PyScrobblerNetworkAdapter]]:
+    """Create two networks and close them when command execution ends."""
+    profile_service = create_profile_service(context.config_path)
+
+    source_config = run_core_operation(
+        context,
+        partial(
+            profile_service.resolve,
+            source_profile,
+        ),
+    )
+    target_config = run_core_operation(
+        context,
+        partial(
+            profile_service.resolve,
+            target_profile,
+        ),
+    )
+
+    factory = NetworkFactory()
+
+    with ExitStack() as stack:
+        source_network = run_core_operation(
+            context,
+            partial(factory.create, source_config),
+        )
+        stack.callback(
+            run_core_operation,
+            context,
+            source_network.close,
+        )
+
+        target_network = run_core_operation(
+            context,
+            partial(factory.create, target_config),
+        )
+        stack.callback(
+            run_core_operation,
+            context,
+            target_network.close,
+        )
+
+        yield source_network, target_network

{syncfm_core-0.2.4 → syncfm_core-0.3.0}/src/syncfm_core/cli/commands/profile.py

@@ -35,7 +35,7 @@ def add_profile_command(
         typer.Option("--api-key", "--api_key", help="Network API key."),
     ],
     hostname: Annotated[
-        str | None, typer.Option("--hostname", help="GNU.fm instance hostname.")
+        str | None, typer.Option("--hostname", help="LoneFM instance hostname.")
     ] = None,
     proxy: Annotated[
         str | None,

{syncfm_core-0.2.4 → syncfm_core-0.3.0}/src/syncfm_core/cli/commands/resume.py

@@ -96,13 +96,11 @@ def resume_command(
         source_label=resolved_source_profile,
         target_label=resolved_target_profile,
     )
-    source_network, target_network = create_network_pair(
+    with create_network_pair(
         cli_context,
         resolved_source_profile,
         resolved_target_profile,
-    )
-
-    with progress_presenter:
+    ) as (source_network, target_network):
         result = run_core_operation(
             cli_context,
             partial(
@@ -113,15 +111,16 @@ def resume_command(
                 source_profile=resolved_source_profile,
                 target_profile=resolved_target_profile,
             ),
+            progress=progress_presenter,
         )
 
-    present_result_and_retry_missing(
-        cli_context,
-        sync_service,
-        source_network,
-        target_network,
-        result,
-        progress_presenter,
-        source_profile=resolved_source_profile,
-        target_profile=resolved_target_profile,
-    )
+        present_result_and_retry_missing(
+            cli_context,
+            sync_service,
+            source_network,
+            target_network,
+            result,
+            progress_presenter,
+            source_profile=resolved_source_profile,
+            target_profile=resolved_target_profile,
+        )

{syncfm_core-0.2.4 → syncfm_core-0.3.0}/src/syncfm_core/cli/commands/sync.py

@@ -81,18 +81,16 @@ def sync_command(
         )
         raise typer.Exit(code=2)
 
-    source_network, target_network = create_network_pair(
+    with create_network_pair(
         cli_context,
         source_profile,
         target_profile,
-    )
-
-    request = SyncRequest(
-        start_timestamp=start_timestamp,
-        end_timestamp=end_timestamp,
-    )
+    ) as (source_network, target_network):
+        request = SyncRequest(
+            start_timestamp=start_timestamp,
+            end_timestamp=end_timestamp,
+        )
 
-    with progress_presenter:
         result = run_core_operation(
             cli_context,
             partial(
@@ -103,15 +101,16 @@ def sync_command(
                 source_profile=source_profile,
                 target_profile=target_profile,
             ),
+            progress=progress_presenter,
         )
 
-    present_result_and_retry_missing(
-        cli_context,
-        sync_service,
-        source_network,
-        target_network,
-        result,
-        progress_presenter,
-        source_profile=source_profile,
-        target_profile=target_profile,
-    )
+        present_result_and_retry_missing(
+            cli_context,
+            sync_service,
+            source_network,
+            target_network,
+            result,
+            progress_presenter,
+            source_profile=source_profile,
+            target_profile=target_profile,
+        )

{syncfm_core-0.2.4 → syncfm_core-0.3.0}/src/syncfm_core/cli/context.py

@@ -2,6 +2,7 @@
 
 import logging
 from collections.abc import Callable
+from contextlib import AbstractContextManager, nullcontext
 from dataclasses import dataclass
 from pathlib import Path
 
@@ -40,10 +41,13 @@ def get_cli_context(context: typer.Context) -> CLIContext:
 def run_core_operation[T](
     context: CLIContext,
     operation: Callable[[], T],
+    *,
+    progress: AbstractContextManager[object] | None = None,
 ) -> T:
-    """Execute an application operation with user-facing error handling."""
+    """Execute an operation, restoring progress output before reporting errors."""
     try:
-        return operation()
+        with progress if progress is not None else nullcontext():
+            return operation()
     except SyncFMCoreError as error:
         message = str(error).strip() or type(error).__name__
         context.error_console.print(

{syncfm_core-0.2.4 → syncfm_core-0.3.0}/src/syncfm_core/cli/verification.py

@@ -45,8 +45,7 @@ def present_result_and_retry_missing(
         )
 
         should_retry = typer.confirm(
-            f"Try synchronizing these {len(missing)} "
-            "missing scrobble(s) again?",
+            f"Try synchronizing these {len(missing)} missing scrobble(s) again?",
             default=True,
         )
 
@@ -62,15 +61,15 @@ def present_result_and_retry_missing(
             end_timestamp=verification.end_timestamp,
         )
 
-        with progress_presenter:
-            result = run_core_operation(
-                context,
-                partial(
-                    sync_service.sync,
-                    source,
-                    target,
-                    retry_request,
-                    source_profile=source_profile,
-                    target_profile=target_profile,
-                ),
-            )
+        result = run_core_operation(
+            context,
+            partial(
+                sync_service.sync,
+                source,
+                target,
+                retry_request,
+                source_profile=source_profile,
+                target_profile=target_profile,
+            ),
+            progress=progress_presenter,
+        )

{syncfm_core-0.2.4 → syncfm_core-0.3.0}/src/syncfm_core/models/network_config.py

@@ -1,5 +1,7 @@
 """Domain models defining supported music networks and their configurations."""
 
+from __future__ import annotations
+
 from dataclasses import dataclass
 from enum import StrEnum
 
@@ -9,7 +11,7 @@ class NetworkType(StrEnum):
 
     LASTFM = "lastfm"
     LIBREFM = "librefm"
-    GNUFM = "gnufm"
+    LONEFM = "lonefm"
 
     @property
     def display_name(self) -> str:
@@ -19,8 +21,15 @@ class NetworkType(StrEnum):
                 return "Last.fm"
             case NetworkType.LIBREFM:
                 return "Libref.fm"
-            case NetworkType.GNUFM:
-                return "GNU.fm"
+            case NetworkType.LONEFM:
+                return "LoneFM"
+
+    @classmethod
+    def _missing_(cls, value: object) -> NetworkType | None:
+        """Accept the legacy GNUFM configuration value."""
+        if value == "gnufm":
+            return cls.LONEFM
+        return None
 
 
 @dataclass(frozen=True, slots=True)

{syncfm_core-0.2.4 → syncfm_core-0.3.0}/src/syncfm_core/models/scrobble.py

@@ -1,6 +1,6 @@
 """Domain models representing scrobbles and their associated track metadata."""
 
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 
 
 @dataclass(frozen=True, slots=True)
@@ -20,3 +20,4 @@ class Scrobble:
     timestamp: int
     album: str | None = None
     metadata: TrackMetadata | None = None
+    image: str | None = field(default=None, kw_only=True)