etherlyzer 0.5.2__tar.gz → 0.5.3__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: etherlyzer
-Version: 0.5.2
+Version: 0.5.3
 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.3}/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.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "etherlyzer"
-version = "0.5.2"
+version = "0.5.3"
 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.3}/src/etherlyzer/exporter.py

@@ -1,7 +1,7 @@
-from etherlyzer.util.settings import config
+from etherlyzer.util.knobs import config
 from etherlyzer.formatters import MACFormatter
 
-from etherlyzer.ieee.registry import IEEEEntry
+from etherlyzer.ieee.ieee_registry import IEEEEntry
 
 
 class RegistryMatchExporter:

{etherlyzer-0.5.2 → etherlyzer-0.5.3}/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 config
 from string import punctuation
 
 

{etherlyzer-0.5.2 → etherlyzer-0.5.3}/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.3/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 config
 
 
 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:

{etherlyzer-0.5.2 → etherlyzer-0.5.3}/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.3}/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 handle_settings_file
 
 
 def build_parser() -> argparse.ArgumentParser:
@@ -34,6 +37,8 @@ def build_parser() -> argparse.ArgumentParser:
 
 
 def main(argv: list[str] | None = None) -> int:
+    handle_settings_file()
+
     parser = build_parser()
 
     args = parser.parse_args(argv)

{etherlyzer-0.5.2 → etherlyzer-0.5.3}/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.3}/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.2/src/etherlyzer/util/settings.py → etherlyzer-0.5.3/src/etherlyzer/util/knobs.py

@@ -5,50 +5,60 @@ from pathlib import Path
 
 from dotenv import load_dotenv
 
-load_dotenv("etherlyzer.env")
+from etherlyzer.util.dirs import DATA_PLATFORM_DIR
 
 
-class MACCase(StrEnum):
+
+class MACCasing(StrEnum):
     UPPER = "upper"
     LOWER = "lower"
 
 
 @dataclass(slots=True, frozen=True)
-class Settings:
+class EtherlyzerKnobs:
     db_update_interval_hours: int = 24
 
     field_separator: str = ";"
     mac_separator: str = "."
     mac_block_size: int = 4
-    mac_case: MACCase = MACCase.UPPER
+    mac_case: MACCasing = MACCasing.UPPER
 
     show_sync_messages: bool = False
 
+    def __post_init__(self) -> None:  # noqa
+        if not (DATA_PLATFORM_DIR / "etherlyzer.env").exists():
+            from importlib.resources import files
+            import shutil
+            template_env = files("etherlyzer").joinpath("etherlyzer.env")
+            destination_env = DATA_PLATFORM_DIR / "etherlyzer.env"
+            with template_env.open("rb") as src, destination_env.open("wb") as dst:
+                shutil.copyfileobj(src, dst)
+        load_dotenv(DATA_PLATFORM_DIR / "etherlyzer.env")
 
 
-def validate_config(conf: Settings) -> None:
-    if conf.db_update_interval_hours <= 0:
+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(conf.field_separator) != 1:
+    if len(etherlyzer_knobs.field_separator) != 1:
         raise ValueError(
             "FIELD_SEPARATOR must contain exactly one character."
         )
 
-    if conf.mac_separator not in {"", ":", "-", "."}:
+    if etherlyzer_knobs.mac_separator not in {"", ":", "-", "."}:
         raise ValueError(
             "MAC_SEPARATOR must be one of '', ':', '-', or '.'."
         )
 
-    if conf.mac_block_size not in {2, 4, 12}:
+    if etherlyzer_knobs.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:
+def load_from_env(cls: type[EtherlyzerKnobs]) -> EtherlyzerKnobs:
     values = {}
 
     for field in fields(cls):
@@ -90,5 +100,5 @@ def load_config(cls: type[Settings]) -> Settings:
     return cls(**values)
 
 
-config = load_config(Settings)
-validate_config(config)
+config = load_from_env(EtherlyzerKnobs)
+validate_knobs(config)