etherlyzer 0.5.2__tar.gz → 0.5.4__tar.gz

{etherlyzer-0.5.2 → etherlyzer-0.5.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: etherlyzer
-Version: 0.5.2
+Version: 0.5.4
 Summary: Fast offline lookup and classification of Ethernet-related identifiers.
 License-Expression: MIT
 License-File: LICENSE
@@ -18,9 +18,9 @@ Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: System :: Networking
 Classifier: Topic :: Security
 Classifier: Typing :: Typed
-Requires-Dist: pandas (>=3.0.5,<4.0.0)
-Requires-Dist: platformdirs (>=4.10.0,<5.0.0)
-Requires-Dist: python-dotenv (>=1.2.2,<2.0.0)
+Requires-Dist: pandas (>=3.0.6,<4.0.0)
+Requires-Dist: platformdirs (>=4.12.2,<5.0.0)
+Requires-Dist: python-dotenv (>=1.2.4,<2.0.0)
 Requires-Dist: requests (>=2.34.2,<3.0.0)
 Requires-Dist: tqdm (>=4.70.1,<5.0.0)
 Project-URL: Homepage, https://github.com/blue-hexagon/EtherLyzer
@@ -62,7 +62,7 @@ Typical use cases include:
 
 Etherlyzer automatically fetches the official IEEE registry listings once every 24 hours, ensuring that the local registry data remains up to date. IEEE states that its public listings are updated every 24 hours.
 
-The synchronization interval can be adjusted to your preference in the shipped `etherlyzer.env` file.
+The synchronization interval can be adjusted to your preference in the shipped `src/etherlyzer/etherlyzer.env` file.
 
 ## Showcasing
 
@@ -226,7 +226,7 @@ etherlyzer format l..iIdOØ1!23-4oo.. --fix-typos --casing "upper" --block-size
 
 ## Configuration
 
-The included `etherlyzer.env` file provides sensible defaults and works out of the box but is configurable.
+The included `src/etherlyzer/etherlyzer.env` file provides sensible defaults and works out of the box but is configurable.
 
 
 ```dotenv

{etherlyzer-0.5.2 → etherlyzer-0.5.4}/README.md

@@ -32,7 +32,7 @@ Typical use cases include:
 
 Etherlyzer automatically fetches the official IEEE registry listings once every 24 hours, ensuring that the local registry data remains up to date. IEEE states that its public listings are updated every 24 hours.
 
-The synchronization interval can be adjusted to your preference in the shipped `etherlyzer.env` file.
+The synchronization interval can be adjusted to your preference in the shipped `src/etherlyzer/etherlyzer.env` file.
 
 ## Showcasing
 
@@ -196,7 +196,7 @@ etherlyzer format l..iIdOØ1!23-4oo.. --fix-typos --casing "upper" --block-size
 
 ## Configuration
 
-The included `etherlyzer.env` file provides sensible defaults and works out of the box but is configurable.
+The included `src/etherlyzer/etherlyzer.env` file provides sensible defaults and works out of the box but is configurable.
 
 
 ```dotenv

{etherlyzer-0.5.2 → etherlyzer-0.5.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "etherlyzer"
-version = "0.5.2"
+version = "0.5.4"
 description = "Fast offline lookup and classification of Ethernet-related identifiers."
 readme = "README.md"
 requires-python = ">=3.14"
@@ -38,9 +38,9 @@ classifiers = [
 
 dependencies = [
     "requests (>=2.34.2,<3.0.0)",
-    "python-dotenv>=1.2.2,<2.0.0",
-    "platformdirs (>=4.10.0,<5.0.0)",
-    "pandas (>=3.0.5,<4.0.0)",
+    "python-dotenv>=1.2.4,<2.0.0",
+    "platformdirs (>=4.12.2,<5.0.0)",
+    "pandas (>=3.0.6,<4.0.0)",
     "tqdm (>=4.70.1,<5.0.0)",
 ]
 
@@ -58,15 +58,15 @@ packages = [
     { include = "etherlyzer", from = "src" }
 ]
 include = [
-    { path = "etherlyzer.env", format = ["sdist", "wheel"] }
+    { path = "src/etherlyzer/etherlyzer.env", format = ["sdist", "wheel"] }
 ]
 
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^9.1.1"
 pytest-cov = "^7.1.0"
-mypy = "^2.2.0"
-ruff = "^0.15.21"
+mypy = "^2.4.0"
+ruff = "^0.16.10"
 
 
 [tool.pytest.ini_options]

{etherlyzer-0.5.2 → etherlyzer-0.5.4}/src/etherlyzer/exporter.py

@@ -1,7 +1,7 @@
-from etherlyzer.util.settings import config
+from etherlyzer.util.knobs import etherlyzer_knobs
 from etherlyzer.formatters import MACFormatter
 
-from etherlyzer.ieee.registry import IEEEEntry
+from etherlyzer.ieee.ieee_registry import IEEEEntry
 
 
 class RegistryMatchExporter:
@@ -10,9 +10,9 @@ class RegistryMatchExporter:
         for entry in entries:
             try:
                 print(
-                    f"{entry.registry}{config.field_separator}"
-                    f"{MACFormatter.format_default(entry.assignment)}{config.field_separator}"
-                    f"{entry.organization_name}{config.field_separator}"
+                    f"{entry.registry}{etherlyzer_knobs.field_separator}"
+                    f"{MACFormatter.format_default(entry.assignment)}{etherlyzer_knobs.field_separator}"
+                    f"{entry.organization_name}{etherlyzer_knobs.field_separator}"
                     f"{entry.organization_address}"
                     f""
                 )

{etherlyzer-0.5.2 → etherlyzer-0.5.4}/src/etherlyzer/formatters.py

@@ -1,7 +1,7 @@
 from enum import StrEnum
 from typing import Literal
 
-from etherlyzer.util.settings import config
+from etherlyzer.util.knobs import etherlyzer_knobs
 from string import punctuation
 
 
@@ -43,11 +43,11 @@ class MACFormatter:
     @classmethod
     def format_default(cls, mac: str) -> str:
         mac = cls.normalize(mac)
-        mac = config.mac_separator.join(
-            mac[i: i + config.mac_block_size] for i in range(0, len(mac), config.mac_block_size)
+        mac = etherlyzer_knobs.mac_separator.join(
+            mac[i: i + etherlyzer_knobs.mac_block_size] for i in range(0, len(mac), etherlyzer_knobs.mac_block_size)
         )
 
-        return getattr(mac, config.mac_case.value)()
+        return getattr(mac, etherlyzer_knobs.mac_case.value)()
 
     @classmethod
     def format_with_stuffed_hex(cls, mac: str, stuffed_hex: str) -> str:

{etherlyzer-0.5.2 → etherlyzer-0.5.4}/src/etherlyzer/ieee/catalog.py

@@ -1,4 +1,4 @@
-from etherlyzer.ieee.registry import RegCategory, IEEEEntry, EtherTypeEntry, IEEERegistry
+from etherlyzer.ieee.ieee_registry import RegCategory, IEEEEntry, EtherTypeEntry, IEEERegistry
 
 
 class Catalog:

etherlyzer-0.5.2/src/etherlyzer/ieee/registry.py → etherlyzer-0.5.4/src/etherlyzer/ieee/ieee_registry.py

@@ -8,8 +8,8 @@ from requests import RequestException
 from tqdm import tqdm
 
 from etherlyzer.ieee.csv_parser import IEEERegistryReader
-from etherlyzer.util.dirs import IEEE_DATA_PLATDIR
-from etherlyzer.util.settings import config
+from etherlyzer.util.dirs import DATA_PLATFORM_DIR
+from etherlyzer.util.knobs import etherlyzer_knobs
 
 
 class RegCategory(StrEnum):
@@ -96,7 +96,7 @@ class IEEERegistry:
 
     @property
     def filepath(self) -> Path:
-        return IEEE_DATA_PLATDIR / Path("".join([self.name, ".csv"]))
+        return DATA_PLATFORM_DIR / Path("".join([self.name, ".csv"]))
 
     @property
     def assignment_length(self) -> int:
@@ -123,11 +123,11 @@ class IEEERegistry:
         now = datetime.datetime.now(datetime.UTC)
         f_not_exists = not self.filepath.exists()
 
-        if f_not_exists and config.show_sync_messages:
+        if f_not_exists and etherlyzer_knobs.show_sync_messages:
             print(f"Cache for {self.name} not found.")
-        elif expires <= now and config.show_sync_messages:
+        elif expires <= now and etherlyzer_knobs.show_sync_messages:
             print(f"Cache for {self.name} has expired.")
-        elif config.show_sync_messages:
+        elif etherlyzer_knobs.show_sync_messages:
             print(f"Cache for {self.name} expires at: {expires_humanized} UTC")
 
         return f_not_exists or expires <= now
@@ -138,7 +138,7 @@ class IEEERegistry:
 
         while attempts <= max_attempts:
             try:
-                if config.show_sync_messages:
+                if etherlyzer_knobs.show_sync_messages:
                     print(f"Saving Registry: {self.name}")
 
                 res = requests.get(
@@ -158,7 +158,7 @@ class IEEERegistry:
                             unit_scale=True,
                             unit_divisor=1024,
                             desc=f"Saving {self.name}",
-                            disable=not config.show_sync_messages,
+                            disable=not etherlyzer_knobs.show_sync_messages,
                     ) as progress:
                         for chunk in res.iter_content(chunk_size=8192):
                             if chunk:
@@ -168,7 +168,7 @@ class IEEERegistry:
                 return None
 
             except RequestException as exc:
-                if config.show_sync_messages:
+                if etherlyzer_knobs.show_sync_messages:
                     print(
                         f"Request timed out on attempt "
                         f"{attempts} of {max_attempts}."

{etherlyzer-0.5.2 → etherlyzer-0.5.4}/src/etherlyzer/ieee/index.py

@@ -5,7 +5,7 @@ from pathlib import Path
 from time import sleep
 from typing import TypeVar
 
-from etherlyzer.ieee.registry import RegCategory, IEEEEntry, EtherTypeEntry, IEEERegistry
+from etherlyzer.ieee.ieee_registry import RegCategory, IEEEEntry, EtherTypeEntry, IEEERegistry
 
 HEX_DIGITS = frozenset("0123456789ABCDEF")
 

{etherlyzer-0.5.2 → etherlyzer-0.5.4}/src/etherlyzer/terminal/cli.py

@@ -1,8 +1,11 @@
 from __future__ import annotations
 
 import argparse
+from pathlib import Path
 
 from etherlyzer.terminal.commands import info, format, normalize, identify, update, bulk
+from etherlyzer.util.dirs import DATA_PLATFORM_DIR
+from etherlyzer.util.knobs import etherlyzer_knobs
 
 
 def build_parser() -> argparse.ArgumentParser:

{etherlyzer-0.5.2 → etherlyzer-0.5.4}/src/etherlyzer/terminal/commands/identify.py

@@ -3,7 +3,7 @@ import re
 from etherlyzer.formatters import MACFormatter
 from etherlyzer.ieee.index import IEEEIndex
 from etherlyzer.ieee.catalog import Catalog
-from etherlyzer.ieee.registry import RegCategory, EtherTypeEntry
+from etherlyzer.ieee.ieee_registry import RegCategory, EtherTypeEntry
 
 
 def run(args):

{etherlyzer-0.5.2 → etherlyzer-0.5.4}/src/etherlyzer/util/dirs.py

@@ -3,4 +3,4 @@ from pathlib import Path
 from platformdirs import user_cache_dir
 
 PROJECT_ROOT = Path(__file__).parent.parent.parent
-IEEE_DATA_PLATDIR = Path(user_cache_dir(appname="etherlyzer", appauthor="Manjana", version="1.0", ensure_exists=True))
+DATA_PLATFORM_DIR = Path(user_cache_dir(appname="etherlyzer", appauthor="Manjana", version="1.0", ensure_exists=True))

etherlyzer-0.5.4/src/etherlyzer/util/knobs.py

@@ -0,0 +1,120 @@
+import os
+import shutil
+
+from dataclasses import MISSING, dataclass, fields
+from enum import Enum, StrEnum
+from importlib.resources import files
+from pathlib import Path
+
+from dotenv import load_dotenv
+
+from etherlyzer.util.dirs import DATA_PLATFORM_DIR
+
+
+class MACCasing(StrEnum):
+    UPPER = "upper"
+    LOWER = "lower"
+
+
+@dataclass(slots=True, frozen=True)
+class EtherlyzerKnobs:
+    db_update_interval_hours: int = 24
+
+    field_separator: str = ";"
+    mac_separator: str = "."
+    mac_block_size: int = 4
+    mac_case: MACCasing = MACCasing.UPPER
+
+    show_sync_messages: bool = False
+
+
+def _load_environment() -> None:
+    DATA_PLATFORM_DIR.mkdir(parents=True, exist_ok=True)
+
+    destination_env = DATA_PLATFORM_DIR / "etherlyzer.env"
+
+    if not destination_env.exists():
+        template_env = files("etherlyzer").joinpath("etherlyzer.env")
+
+        with template_env.open("rb") as src, destination_env.open("wb") as dst:
+            shutil.copyfileobj(src, dst)
+
+    load_dotenv(destination_env)
+
+
+def _validate_knobs(etherlyzer_knobs: EtherlyzerKnobs) -> None:
+    if etherlyzer_knobs.db_update_interval_hours <= 0:
+        raise ValueError(
+            "DB_UPDATE_INTERVAL_HOURS must be greater than zero."
+        )
+
+    if len(etherlyzer_knobs.field_separator) != 1:
+        raise ValueError(
+            "FIELD_SEPARATOR must contain exactly one character."
+        )
+
+    if etherlyzer_knobs.mac_separator not in {"", ":", "-", "."}:
+        raise ValueError(
+            "MAC_SEPARATOR must be one of '', ':', '-', or '.'."
+        )
+
+    if etherlyzer_knobs.mac_block_size not in {2, 4, 12}:
+        raise ValueError(
+            "MAC_BLOCK_SIZE must be 2, 4, or 12."
+        )
+
+
+def knobs_builder(cls: type[EtherlyzerKnobs]) -> EtherlyzerKnobs:
+    values = {}
+
+    for field in fields(cls):
+        env_name = field.name.upper()
+        value = os.getenv(env_name)
+
+        if value is None:
+            if field.default is not MISSING:
+                values[field.name] = field.default
+                continue
+
+            if field.default_factory is not MISSING:
+                values[field.name] = field.default_factory()
+                continue
+
+            raise ValueError(
+                f"Missing required environment variable {env_name}"
+            )
+
+        type_ = field.type
+
+        if type_ is bool:
+            values[field.name] = value.lower() in {
+                "1", "true", "yes", "on"
+            }
+
+        elif type_ is int:
+            values[field.name] = int(value)
+
+        elif type_ is float:
+            values[field.name] = float(value)
+
+        elif type_ is str:
+            values[field.name] = value
+
+        elif type_ is Path:
+            values[field.name] = Path(value)
+
+        elif issubclass(type_, Enum):
+            values[field.name] = type_(value)
+
+        else:
+            raise TypeError(
+                f"Unsupported config type: {type_}"
+            )
+
+    return cls(**values)
+
+
+_load_environment()
+
+etherlyzer_knobs = knobs_builder(EtherlyzerKnobs)
+_validate_knobs(etherlyzer_knobs)

etherlyzer-0.5.2/src/etherlyzer/util/settings.py

@@ -1,94 +0,0 @@
-import os
-from dataclasses import MISSING, dataclass, fields
-from enum import Enum, StrEnum
-from pathlib import Path
-
-from dotenv import load_dotenv
-
-load_dotenv("etherlyzer.env")
-
-
-class MACCase(StrEnum):
-    UPPER = "upper"
-    LOWER = "lower"
-
-
-@dataclass(slots=True, frozen=True)
-class Settings:
-    db_update_interval_hours: int = 24
-
-    field_separator: str = ";"
-    mac_separator: str = "."
-    mac_block_size: int = 4
-    mac_case: MACCase = MACCase.UPPER
-
-    show_sync_messages: bool = False
-
-
-
-def validate_config(conf: Settings) -> None:
-    if conf.db_update_interval_hours <= 0:
-        raise ValueError(
-            "DB_UPDATE_INTERVAL_HOURS must be greater than zero."
-        )
-
-    if len(conf.field_separator) != 1:
-        raise ValueError(
-            "FIELD_SEPARATOR must contain exactly one character."
-        )
-
-    if conf.mac_separator not in {"", ":", "-", "."}:
-        raise ValueError(
-            "MAC_SEPARATOR must be one of '', ':', '-', or '.'."
-        )
-
-    if conf.mac_block_size not in {2, 4, 12}:
-        raise ValueError(
-            "MAC_BLOCK_SIZE must be 2, 4, or 12."
-        )
-
-
-def load_config(cls: type[Settings]) -> Settings:
-    values = {}
-
-    for field in fields(cls):
-        env_name = field.name.upper()
-
-        value = os.getenv(env_name)
-
-        if value is None:
-            if field.default is not MISSING:
-                values[field.name] = field.default
-            elif field.default_factory is not MISSING:
-                values[field.name] = field.default_factory()
-            else:
-                raise ValueError(
-                    f"Missing required environment variable {env_name}"
-                )
-
-        type_ = field.type
-
-        if type_ is bool:
-            values[field.name] = value.lower() in {"1", "true", "yes", "on"}
-
-        elif type_ is int:
-            values[field.name] = int(value)
-
-        elif type_ is float:
-            values[field.name] = float(value)
-
-        elif type_ is str:
-            values[field.name] = value
-        elif type_ is Path:
-            values[field.name] = Path(value)
-
-        elif issubclass(type_, Enum):
-            values[field.name] = type_(value)
-
-        else:
-            raise TypeError(f"Unsupported config type: {type_}")
-    return cls(**values)
-
-
-config = load_config(Settings)
-validate_config(config)