oscura 0.1.0__py3-none-any.whl → 0.1.1__py3-none-any.whl

oscura/export/__init__.py

@@ -1,6 +1,6 @@
-"""Export module for TraceKit protocol definitions.
+"""Export module for Oscura protocol definitions.
 
-This module provides functionality to export TraceKit protocol definitions
+This module provides functionality to export Oscura protocol definitions
 to various formats for integration with other tools and workflows.
 
 Supported export formats:

oscura/export/wireshark/__init__.py

@@ -1,6 +1,6 @@
 """Wireshark dissector export module.
 
-This module provides functionality to export TraceKit protocol definitions
+This module provides functionality to export Oscura protocol definitions
 as Wireshark Lua dissectors for integration with Wireshark's protocol
 analysis tools.
 

oscura/export/wireshark/generator.py

@@ -1,6 +1,6 @@
 """Wireshark Lua dissector generator.
 
-This module generates Wireshark Lua dissectors from TraceKit protocol definitions.
+This module generates Wireshark Lua dissectors from Oscura protocol definitions.
 The generated dissectors can be loaded into Wireshark for interactive protocol analysis.
 
 Features:
@@ -29,7 +29,7 @@ from .validator import validate_lua_syntax
 class WiresharkDissectorGenerator:
     """Generate Wireshark Lua dissectors from protocol definitions.
 
-    This class converts TraceKit protocol definitions into Wireshark Lua
+    This class converts Oscura protocol definitions into Wireshark Lua
     dissectors that can be loaded into Wireshark for protocol analysis.
 
     Features:

oscura/export/wireshark/templates/dissector.lua.j2

@@ -1,5 +1,5 @@
 -- {{ protocol.name }}.lua
--- Generated by TraceKit on {{ timestamp }}
+-- Generated by Oscura on {{ timestamp }}
 --
 -- Protocol: {{ protocol.description }}
 -- Version: {{ protocol.version }}

oscura/export/wireshark/type_mapping.py

@@ -1,6 +1,6 @@
-"""Type mapping between TraceKit field types and Wireshark ProtoField types.
+"""Type mapping between Oscura field types and Wireshark ProtoField types.
 
-This module provides mappings from TraceKit protocol field types to their
+This module provides mappings from Oscura protocol field types to their
 corresponding Wireshark Lua ProtoField types and display bases.
 
 References:
@@ -9,7 +9,7 @@ References:
 
 from typing import Literal
 
-# Map TraceKit field types to Wireshark ProtoField types
+# Map Oscura field types to Wireshark ProtoField types
 FIELD_TYPE_MAPPING: dict[str, str] = {
     "uint8": "ProtoField.uint8",
     "uint16": "ProtoField.uint16",
@@ -54,10 +54,10 @@ DEFAULT_BASE: dict[str, str] = {
 
 
 def get_protofield_type(field_type: str, display_base: str | None = None) -> tuple[str, str]:
-    """Map TraceKit field type to Wireshark ProtoField and display base.
+    """Map Oscura field type to Wireshark ProtoField and display base.
 
     Args:
-        field_type: TraceKit field type (uint8, uint16, string, etc.)
+        field_type: Oscura field type (uint8, uint16, string, etc.)
         display_base: Optional display base (dec, hex, oct, bin, none)
 
     Returns:
@@ -88,7 +88,7 @@ def get_field_size(field_type: str) -> int | None:
     """Get the fixed size in bytes for a field type.
 
     Args:
-        field_type: TraceKit field type
+        field_type: Oscura field type
 
     Returns:
         Field size in bytes, or None for variable-length types
@@ -115,7 +115,7 @@ def is_variable_length(field_type: str) -> bool:
     """Check if a field type is variable length.
 
     Args:
-        field_type: TraceKit field type
+        field_type: Oscura field type
 
     Returns:
         True if field is variable length
@@ -127,7 +127,7 @@ def get_lua_reader_function(field_type: str, endian: Literal["big", "little"] =
     """Get the Lua buffer reader function for a field type.
 
     Args:
-        field_type: TraceKit field type
+        field_type: Oscura field type
         endian: Byte order (big or little endian)
 
     Returns:

oscura/exporters/__init__.py

@@ -1,4 +1,4 @@
-"""Data export module for TraceKit.
+"""Data export module for Oscura.
 
 Provides export functionality to various file formats including CSV, HDF5,
 JSON, MATLAB, Markdown, HTML, NumPy NPZ, and SPICE PWL.
@@ -32,7 +32,7 @@ from oscura.exporters.html_export import (
     generate_html_report,
 )
 from oscura.exporters.json_export import (
-    TraceKitJSONEncoder,
+    OscuraJSONEncoder,
     export_json,
     export_measurements,
     export_protocol_decode,
@@ -57,7 +57,7 @@ from oscura.exporters.spice_export import (
 )
 
 __all__ = [
-    "TraceKitJSONEncoder",
+    "OscuraJSONEncoder",
     "append_trace",
     # CSV export (EXP-001)
     "export_csv",

oscura/exporters/csv.py

@@ -107,7 +107,7 @@ def _export_trace(
         if header:
             # Metadata comments
             meta = trace.metadata
-            f.write("# TraceKit CSV Export\n")
+            f.write("# Oscura CSV Export\n")
             f.write(f"# Sample Rate: {meta.sample_rate} Hz\n")
             f.write(f"# Time Base: {meta.time_base} s\n")
             f.write(f"# Samples: {len(trace.data)}\n")

oscura/exporters/html_export.py

@@ -1,4 +1,4 @@
-"""HTML report export for TraceKit.
+"""HTML report export for Oscura.
 
 This module provides interactive HTML report generation with embedded Plotly charts,
 measurement tables, and custom styling/theming.
@@ -23,7 +23,7 @@ HTML_TEMPLATE = """<!DOCTYPE html>
 <head>
     <meta charset="UTF-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <meta name="generator" content="TraceKit Export">
+    <meta name="generator" content="Oscura Export">
     <title>{title}</title>
     {plotly_script}
     <style>
@@ -235,7 +235,7 @@ HTML_TEMPLATE = """<!DOCTYPE html>
         {conclusions_html}
 
         <footer>
-            Generated by TraceKit &middot; {timestamp}
+            Generated by Oscura &middot; {timestamp}
         </footer>
     </div>
 </body>
@@ -266,7 +266,7 @@ def export_html(
     data: dict[str, Any],
     path: str | Path,
     *,
-    title: str = "TraceKit Analysis Report",
+    title: str = "Oscura Analysis Report",
     author: str | None = None,
     include_plots: bool = True,
     self_contained: bool = True,
@@ -313,7 +313,7 @@ def export_html(
 def generate_html_report(
     data: dict[str, Any],
     *,
-    title: str = "TraceKit Analysis Report",
+    title: str = "Oscura Analysis Report",
     author: str | None = None,
     include_plots: bool = True,
     self_contained: bool = True,

oscura/exporters/json_export.py

@@ -25,8 +25,8 @@ import numpy as np
 from oscura.core.types import DigitalTrace, TraceMetadata, WaveformTrace
 
 
-class TraceKitJSONEncoder(json.JSONEncoder):
-    """JSON encoder with numpy, datetime, and TraceKit object support."""
+class OscuraJSONEncoder(json.JSONEncoder):
+    """JSON encoder with numpy, datetime, and Oscura object support."""
 
     def default(self, obj: Any) -> Any:
         if isinstance(obj, WaveformTrace):
@@ -141,9 +141,9 @@ def export_json(
 
     # Serialize to JSON string
     if pretty:
-        json_str = json.dumps(output, cls=TraceKitJSONEncoder, indent=2)
+        json_str = json.dumps(output, cls=OscuraJSONEncoder, indent=2)
     else:
-        json_str = json.dumps(output, cls=TraceKitJSONEncoder)
+        json_str = json.dumps(output, cls=OscuraJSONEncoder)
 
     # Write to file (with optional compression)
     if compress:
@@ -207,9 +207,9 @@ def export_measurements(
 
     with open(path, "w") as f:
         if pretty:
-            json.dump(output, f, cls=TraceKitJSONEncoder, indent=2)
+            json.dump(output, f, cls=OscuraJSONEncoder, indent=2)
         else:
-            json.dump(output, f, cls=TraceKitJSONEncoder)
+            json.dump(output, f, cls=OscuraJSONEncoder)
 
 
 def export_protocol_decode(
@@ -258,9 +258,9 @@ def export_protocol_decode(
 
     with open(path, "w") as f:
         if pretty:
-            json.dump(output, f, cls=TraceKitJSONEncoder, indent=2)
+            json.dump(output, f, cls=OscuraJSONEncoder, indent=2)
         else:
-            json.dump(output, f, cls=TraceKitJSONEncoder)
+            json.dump(output, f, cls=OscuraJSONEncoder)
 
 
 def load_json(path: str | Path) -> dict[str, Any]:
@@ -283,7 +283,7 @@ def load_json(path: str | Path) -> dict[str, Any]:
 
 
 __all__ = [
-    "TraceKitJSONEncoder",
+    "OscuraJSONEncoder",
     "export_json",
     "export_measurements",
     "export_protocol_decode",

oscura/exporters/markdown_export.py

@@ -1,4 +1,4 @@
-"""Markdown report export for TraceKit.
+"""Markdown report export for Oscura.
 
 This module provides Markdown report generation with measurement tables,
 plot references, and configurable sections.
@@ -22,7 +22,7 @@ def export_markdown(
     data: dict[str, Any],
     path: str | Path,
     *,
-    title: str = "TraceKit Analysis Report",
+    title: str = "Oscura Analysis Report",
     author: str | None = None,
     include_plots: bool = True,
     embed_images: bool = True,
@@ -295,7 +295,7 @@ def _generate_plots_section(
 def generate_markdown_report(
     data: dict[str, Any],
     *,
-    title: str = "TraceKit Analysis Report",
+    title: str = "Oscura Analysis Report",
     author: str | None = None,
     include_plots: bool = True,
     embed_images: bool = True,

oscura/exporters/npz_export.py

@@ -1,4 +1,4 @@
-"""NumPy NPZ export functionality for TraceKit.
+"""NumPy NPZ export functionality for Oscura.
 
 This module provides export to NumPy's compressed archive format for
 efficient storage and fast loading of trace data.

oscura/exporters/spice_export.py

@@ -1,4 +1,4 @@
-"""SPICE PWL export functionality for TraceKit.
+"""SPICE PWL export functionality for Oscura.
 
 This module provides export to SPICE Piece-Wise Linear (PWL) format for
 use in circuit simulation tools like LTspice, ngspice, Cadence, etc.

oscura/extensibility/__init__.py

@@ -1,7 +1,7 @@
 """Extensibility framework for plugins and custom algorithms.
 
 This package provides registries, plugin management, and custom measurement
-frameworks for extending TraceKit functionality.
+frameworks for extending Oscura functionality.
 """
 
 from .docs import (

oscura/extensibility/docs.py

@@ -1,6 +1,6 @@
 """Extension documentation auto-generation system.
 
-This module provides automatic documentation generation for TraceKit extensions
+This module provides automatic documentation generation for Oscura extensions
 including API reference, usage examples, and metadata extraction from docstrings.
 
 

oscura/extensibility/extensions.py

@@ -1,7 +1,7 @@
 """Extension point registry and management system.
 
 This module implements a central registry for extension points that allows
-plugins and custom code to extend TraceKit functionality at well-defined
+plugins and custom code to extend Oscura functionality at well-defined
 integration points.
 """
 
@@ -170,7 +170,7 @@ class HookContext:
         abort_reason: Reason for abort
 
     Example:
-        >>> @tk.hooks.register("pre_decode")
+        >>> @osc.hooks.register("pre_decode")
         >>> def validate_waveform(context):
         ...     if context.data.sample_rate < 1000:
         ...         context.abort = True
@@ -210,19 +210,19 @@ class RegisteredHook:
 
 
 class ExtensionPointRegistry:
-    """Central registry of all extension points in TraceKit.
+    """Central registry of all extension points in Oscura.
 
     Manages registration and lookup of extension points, algorithms,
     and hooks throughout the system.
 
     Example:
         >>> # List all extension points
-        >>> extension_points = tk.extensions.list()
+        >>> extension_points = osc.extensions.list()
         >>> for ep in extension_points:
         ...     print(f"{ep.name} v{ep.version}")
 
         >>> # Get specific extension point
-        >>> decoder_ep = tk.extensions.get("protocol_decoder")
+        >>> decoder_ep = osc.extensions.get("protocol_decoder")
         >>> print(f"Required methods: {decoder_ep.required_methods}")
 
     References:
@@ -256,7 +256,7 @@ class ExtensionPointRegistry:
     def initialize(self) -> None:
         """Initialize built-in extension points.
 
-        Registers the standard extension points that come with TraceKit.
+        Registers the standard extension points that come with Oscura.
         """
         if self._initialized:  # type: ignore[has-type]
             return
@@ -810,7 +810,7 @@ class ExtensionPointRegistry:
             name: Optional hook name for identification
 
         Example:
-            >>> @tk.hooks.register("pre_decode")
+            >>> @osc.hooks.register("pre_decode")
             >>> def validate_waveform(context):
             ...     if context.data.sample_rate < 1000:
             ...         raise ValueError("Sample rate too low")

oscura/extensibility/measurements.py

@@ -35,22 +35,22 @@ class MeasurementDefinition:
         tags: Optional tags for categorization and search.
 
     Example:
-        >>> import oscura as tk
+        >>> import oscura as osc
         >>> def calculate_crest_factor(trace, **kwargs):
         ...     peak = abs(trace.data).max()
         ...     rms = (trace.data ** 2).mean() ** 0.5
         ...     return peak / rms
-        >>> tk.register_measurement(
+        >>> osc.register_measurement(
         ...     name='crest_factor',
         ...     func=calculate_crest_factor,
         ...     units='ratio',
         ...     category='amplitude'
         ... )
-        >>> cf = tk.measure(trace, 'crest_factor')
+        >>> cf = osc.measure(trace, 'crest_factor')
 
     Advanced Example:
         >>> # Define measurement with full metadata
-        >>> slew_rate_defn = tk.MeasurementDefinition(
+        >>> slew_rate_defn = osc.MeasurementDefinition(
         ...     name='max_slew_rate',
         ...     func=lambda trace: abs(trace.derivative()).max(),
         ...     units='V/s',
@@ -58,7 +58,7 @@ class MeasurementDefinition:
         ...     description='Maximum slew rate in trace',
         ...     tags=['edge', 'derivative', 'speed']
         ... )
-        >>> tk.register_measurement(slew_rate_defn)
+        >>> osc.register_measurement(slew_rate_defn)
 
     References:
         API-008: Custom Measurement Framework
@@ -389,12 +389,12 @@ def register_measurement(
         definition: Pre-built MeasurementDefinition.
 
     Example:
-        >>> import oscura as tk
+        >>> import oscura as osc
         >>> def calculate_crest_factor(trace, **kwargs):
         ...     peak = abs(trace.data).max()
         ...     rms = (trace.data ** 2).mean() ** 0.5
         ...     return peak / rms
-        >>> tk.register_measurement(
+        >>> osc.register_measurement(
         ...     name='crest_factor',
         ...     func=calculate_crest_factor,
         ...     units='ratio',
@@ -427,8 +427,8 @@ def measure(trace: WaveformTrace, name: str, **kwargs: Any) -> float:
         Measured value.
 
     Example:
-        >>> import oscura as tk
-        >>> cf = tk.measure(trace, 'crest_factor')
+        >>> import oscura as osc
+        >>> cf = osc.measure(trace, 'crest_factor')
         >>> print(f"Crest factor: {cf:.2f}")
 
     References:
@@ -452,8 +452,8 @@ def list_measurements(
         List of measurement names.
 
     Example:
-        >>> import oscura as tk
-        >>> measurements = tk.list_measurements(category='amplitude')
+        >>> import oscura as osc
+        >>> measurements = osc.list_measurements(category='amplitude')
         >>> print(f"Amplitude measurements: {measurements}")
 
     References:
@@ -469,7 +469,7 @@ def get_measurement_registry() -> MeasurementRegistry:
         Global MeasurementRegistry instance.
 
     Example:
-        >>> registry = tk.get_measurement_registry()
+        >>> registry = osc.get_measurement_registry()
         >>> metadata = registry.get_metadata('crest_factor')
     """
     return _registry

oscura/extensibility/plugins.py

@@ -23,8 +23,8 @@ class PluginError(Exception):
 
     Example:
         >>> try:
-        ...     plugin = tk.load_plugin('oscura.decoders', 'flexray')
-        ... except tk.PluginError as e:
+        ...     plugin = osc.load_plugin('oscura.decoders', 'flexray')
+        ... except osc.PluginError as e:
         ...     print(f"Plugin failed: {e}")
 
     References:
@@ -87,20 +87,20 @@ class PluginManager:
     - oscura.exporters: Export format handlers
 
     Example:
-        >>> import oscura as tk
+        >>> import oscura as osc
         >>> # Plugins auto-discovered from installed packages
         >>> # Use plugin decoder
-        >>> can_frames = tk.decode(trace, protocol='can', baudrate=500000)
+        >>> can_frames = osc.decode(trace, protocol='can', baudrate=500000)
         >>> # List available plugins
-        >>> plugins = tk.list_plugins()
+        >>> plugins = osc.list_plugins()
         >>> print(f"Installed plugins: {plugins}")
 
     Advanced Example:
         >>> # Manually load plugin with error handling
         >>> try:
-        ...     plugin = tk.load_plugin('oscura.decoders', 'flexray')
+        ...     plugin = osc.load_plugin('oscura.decoders', 'flexray')
         ...     print(f"Plugin loaded: {plugin.name} v{plugin.version}")
-        ... except tk.PluginError as e:
+        ... except osc.PluginError as e:
         ...     print(f"Plugin failed to load: {e}")
 
     Plugin Package Example:
@@ -361,8 +361,8 @@ def load_plugin(group: str, name: str) -> PluginMetadata:
         PluginMetadata with loaded plugin.
 
     Example:
-        >>> import oscura as tk
-        >>> plugin = tk.load_plugin('oscura.decoders', 'flexray')
+        >>> import oscura as osc
+        >>> plugin = osc.load_plugin('oscura.decoders', 'flexray')
         >>> print(f"Loaded {plugin.name} v{plugin.version}")
 
     References:
@@ -381,8 +381,8 @@ def list_plugins(group: str | None = None) -> dict[str, list[str]]:
         Dictionary mapping group names to plugin names.
 
     Example:
-        >>> import oscura as tk
-        >>> plugins = tk.list_plugins()
+        >>> import oscura as osc
+        >>> plugins = osc.list_plugins()
         >>> print(f"Available decoders: {plugins['oscura.decoders']}")
 
     References:
@@ -398,7 +398,7 @@ def get_plugin_manager() -> PluginManager:
         Global PluginManager instance.
 
     Example:
-        >>> manager = tk.get_plugin_manager()
+        >>> manager = osc.get_plugin_manager()
         >>> loaded = manager.list_loaded_plugins()
     """
     return _manager

oscura/extensibility/registry.py

@@ -1,7 +1,7 @@
 """Algorithm registry for custom algorithm injection.
 
 This module implements a registry pattern that allows users to register
-custom algorithms and implementations at extension points throughout TraceKit.
+custom algorithms and implementations at extension points throughout Oscura.
 """
 
 from __future__ import annotations
@@ -18,13 +18,13 @@ class AlgorithmRegistry:
 
     Allows users to register custom algorithms for various categories
     (edge detection, peak finding, window functions, etc.) that can be
-    used throughout TraceKit.
+    used throughout Oscura.
 
     The registry validates algorithm signatures on registration and provides
     lookup by category and name.
 
     Example:
-        >>> import oscura as tk
+        >>> import oscura as osc
         >>> def my_edge_detector(data, threshold=0.5):
         ...     '''Custom Schmitt trigger edge detector'''
         ...     edges = []
@@ -36,9 +36,9 @@ class AlgorithmRegistry:
         ...             state = new_state
         ...     return edges
         >>> # Register in algorithm registry
-        >>> tk.register_algorithm('my_schmitt', my_edge_detector, category='edge_detector')
+        >>> osc.register_algorithm('my_schmitt', my_edge_detector, category='edge_detector')
         >>> # Use custom algorithm
-        >>> edges = tk.find_edges(trace, method='my_schmitt', threshold=0.7)
+        >>> edges = osc.find_edges(trace, method='my_schmitt', threshold=0.7)
 
     Advanced Example:
         >>> # Register custom window function
@@ -46,11 +46,11 @@ class AlgorithmRegistry:
         >>> def custom_window(n, alpha=0.5):
         ...     x = np.linspace(0, 1, n)
         ...     return 0.5 * (1 + np.cos(2 * np.pi * alpha * (x - 0.5)))
-        >>> tk.register_algorithm('custom_tukey', custom_window, category='window_func')
+        >>> osc.register_algorithm('custom_tukey', custom_window, category='window_func')
         >>> # Use in FFT
-        >>> result = tk.fft(trace, nfft=8192, window='custom_tukey', alpha=0.3)
+        >>> result = osc.fft(trace, nfft=8192, window='custom_tukey', alpha=0.3)
         >>> # List available algorithms
-        >>> available = tk.get_algorithms('window_func')
+        >>> available = osc.get_algorithms('window_func')
 
     References:
         API-006: Algorithm Override Hooks
@@ -288,10 +288,10 @@ def register_algorithm(
         validate: Whether to validate signature. Default True.
 
     Example:
-        >>> import oscura as tk
+        >>> import oscura as osc
         >>> def my_edge_detector(data, threshold=0.5):
         ...     return find_edges_custom(data, threshold)
-        >>> tk.register_algorithm('my_edges', my_edge_detector, 'edge_detector')
+        >>> osc.register_algorithm('my_edges', my_edge_detector, 'edge_detector')
 
     References:
         API-006: Algorithm Override Hooks
@@ -310,7 +310,7 @@ def get_algorithm(category: str, name: str) -> Callable[..., Any]:
         The registered algorithm function.
 
     Example:
-        >>> edge_detector = tk.get_algorithm('edge_detector', 'my_edges')
+        >>> edge_detector = osc.get_algorithm('edge_detector', 'my_edges')
         >>> edges = edge_detector(data)
 
     References:
@@ -329,7 +329,7 @@ def get_algorithms(category: str) -> list[str]:
         List of algorithm names.
 
     Example:
-        >>> available = tk.get_algorithms('window_func')
+        >>> available = osc.get_algorithms('window_func')
         >>> print(f"Available windows: {available}")
 
     References: