Merge pull request #1 from reward-protocol/dual_import

prepareing for rename by allowing dual import

Author: benjibc

reward_kit/_version.py

@@ -255,11 +255,11 @@ def git_versions_from_keywords(
                 "error": None,
                 "date": date,
             }
-    # no suitable tags, so version is "0+unknown", but full hex is still there
+    # no suitable tags, so version is "0.4.0+unknown", but full hex is still there
     if verbose:
         print("no suitable tags, using unknown + full revision id")
     return {
-        "version": "0+unknown",
+        "version": "0.4.0+unknown",
         "full-revisionid": keywords["full"].strip(),
         "dirty": False,
         "error": "no suitable tags",
@@ -435,7 +435,7 @@ def render_pep440(pieces: Dict[str, Any]) -> str:
                 rendered += ".dirty"
     else:
         # exception #1
-        rendered = "0+untagged.%d.g%s" % (pieces["distance"], pieces["short"])
+        rendered = "0.4.0+untagged.%d.g%s" % (pieces["distance"], pieces["short"])
         if pieces["dirty"]:
             rendered += ".dirty"
     return rendered
@@ -461,7 +461,7 @@ def render_pep440_branch(pieces: Dict[str, Any]) -> str:
                 rendered += ".dirty"
     else:
         # exception #1
-        rendered = "0"
+        rendered = "0.4.0"
         if pieces["branch"] != "master":
             rendered += ".dev0"
         rendered += "+untagged.%d.g%s" % (pieces["distance"], pieces["short"])
@@ -500,7 +500,7 @@ def render_pep440_pre(pieces: Dict[str, Any]) -> str:
             rendered = pieces["closest-tag"]
     else:
         # exception #1
-        rendered = "0.post0.dev%d" % pieces["distance"]
+        rendered = "0.4.0.post0.dev%d" % pieces["distance"]
     return rendered
 
 
@@ -524,7 +524,7 @@ def render_pep440_post(pieces: Dict[str, Any]) -> str:
             rendered += "g%s" % pieces["short"]
     else:
         # exception #1
-        rendered = "0.post%d" % pieces["distance"]
+        rendered = "0.4.0.post%d" % pieces["distance"]
         if pieces["dirty"]:
             rendered += ".dev0"
         rendered += "+g%s" % pieces["short"]
@@ -551,7 +551,7 @@ def render_pep440_post_branch(pieces: Dict[str, Any]) -> str:
                 rendered += ".dirty"
     else:
         # exception #1
-        rendered = "0.post%d" % pieces["distance"]
+        rendered = "0.4.0.post%d" % pieces["distance"]
         if pieces["branch"] != "master":
             rendered += ".dev0"
         rendered += "+g%s" % pieces["short"]
@@ -576,7 +576,7 @@ def render_pep440_old(pieces: Dict[str, Any]) -> str:
                 rendered += ".dev0"
     else:
         # exception #1
-        rendered = "0.post%d" % pieces["distance"]
+        rendered = "0.4.0.post%d" % pieces["distance"]
         if pieces["dirty"]:
             rendered += ".dev0"
     return rendered
@@ -688,7 +688,7 @@ def get_versions() -> Dict[str, Any]:
             root = os.path.dirname(root)
     except NameError:
         return {
-            "version": "0+unknown",
+            "version": "0.4.0+unknown",
             "full-revisionid": None,
             "dirty": None,
             "error": "unable to find root of source tree",
@@ -708,7 +708,7 @@ def get_versions() -> Dict[str, Any]:
         pass
 
     return {
-        "version": "0+unknown",
+        "version": "0.4.0+unknown",
         "full-revisionid": None,
         "dirty": None,
         "error": "unable to compute version",

reward_kit/cli_commands/deploy.py

@@ -15,14 +15,51 @@
 import yaml  # For saving config if save_config helper doesn't exist
 
 # TODO: Consider moving subprocess_manager functions to a more central location if used by core CLI
-from development.utils.subprocess_manager import (
-    start_ngrok_and_get_url,  # Added ngrok function
-)
-from development.utils.subprocess_manager import (
-    start_process,
-    start_serveo_and_get_url,
-    stop_process,
-)
+try:
+    from development.utils.subprocess_manager import (
+        start_ngrok_and_get_url,  # Added ngrok function
+        start_process,
+        start_serveo_and_get_url,
+        stop_process,
+    )
+except ImportError:
+    # Fallback implementations when development module is not available
+    import subprocess
+    import signal
+    import socket
+    
+    def start_process(command, log_path, env=None):
+        """Fallback process starter."""
+        try:
+            with open(log_path, 'w') as log_file:
+                process = subprocess.Popen(
+                    command,
+                    stdout=log_file,
+                    stderr=subprocess.STDOUT,
+                    env=env
+                )
+                return process
+        except Exception as e:
+            print(f"Error starting process: {e}")
+            return None
+    
+    def stop_process(pid):
+        """Fallback process stopper."""
+        try:
+            import os
+            os.kill(pid, signal.SIGTERM)
+        except Exception:
+            pass
+    
+    def start_serveo_and_get_url(local_port, log_path):
+        """Fallback serveo tunnel - returns None to indicate unavailable."""
+        print("Serveo tunneling not available - development module not found")
+        return None, None
+    
+    def start_ngrok_and_get_url(local_port, log_path):
+        """Fallback ngrok tunnel - returns None to indicate unavailable.""" 
+        print("ngrok tunneling not available - development module not found")
+        return None, None
 from reward_kit.auth import get_fireworks_account_id
 from reward_kit.config import GCPCloudRunConfig, RewardKitConfig
 from reward_kit.config import _config_file_path as global_loaded_config_path

reward_protocol/__init__.py

@@ -0,0 +1,50 @@
+"""
+Fireworks Reward Protocol - Simplify reward modeling for LLM RL fine-tuning.
+
+This package provides an alternative import name for reward_kit.
+All functionality from reward_kit is available through reward_protocol.
+
+A Python library for defining, testing, deploying, and using reward functions
+for LLM fine-tuning, including launching full RL jobs on the Fireworks platform.
+
+The library also provides an agent evaluation framework for testing and evaluating
+tool-augmented models using self-contained task bundles.
+"""
+
+# Re-export everything from reward_kit
+from reward_kit import *
+from reward_kit import __version__
+
+# Make sure all public symbols are available
+from reward_kit import __all__
+
+# Additional convenience imports for common submodules
+from reward_kit import (
+    adapters,
+    agent,
+    auth,
+    cli,
+    cli_commands,
+    common_utils,
+    config,
+    datasets,
+    evaluation,
+    execution,
+    gcp_tools,
+    generation,
+    generic_server,
+    integrations,
+    mcp,
+    mcp_agent,
+    models,
+    packaging,
+    platform_api,
+    playback_policy,
+    resources,
+    reward_function,
+    rewards,
+    rl_processing,
+    server,
+    typed_interface,
+    utils,
+) 

setup.py

@@ -6,7 +6,7 @@
     name="reward-kit",
     version=versioneer.get_version(),
     cmdclass=versioneer.get_cmdclass(),
-    packages=find_packages(),
+    packages=find_packages(include=["reward_kit*", "reward_protocol*", "development*"]),
     install_requires=[
         "requests>=2.25.0",
         "pydantic>=2.0.0",
@@ -68,6 +68,7 @@
         "console_scripts": [
             "fireworks-reward=reward_kit.cli:main",
             "reward-kit=reward_kit.cli:main",
+            "reward-protocol=reward_kit.cli:main",
         ],
     },
     author="Fireworks AI",

tests/reward_protocol_tests/README.md

@@ -0,0 +1,62 @@
+# Reward Protocol Tests
+
+This directory contains tests specifically for verifying the `reward_protocol` dual import functionality.
+
+## Test Files
+
+### `test_reward_protocol_import.py`
+- Comprehensive pytest-compatible test suite
+- Tests import equivalence between `reward_kit` and `reward_protocol`
+- Verifies that both packages provide identical functionality
+- Tests require all dependencies to be installed
+
+### `test_reward_protocol_simple.py`
+- Basic import tests that work with a fully installed environment
+- Tests that both packages can be imported and provide the same functionality
+- Verifies version consistency and API equivalence
+
+### `test_minimal_structure.py`
+- Structure verification tests that work without dependencies
+- Tests package discovery, file structure, and configuration
+- Verifies that the build process includes both packages
+- ✅ **Passes in development environment**
+
+### `test_import_equivalence.py`
+- Tests import equivalence by examining module structure
+- Verifies console scripts and package metadata
+- Tests that `reward_protocol` properly re-exports `reward_kit`
+- ✅ **Passes in development environment**
+
+### `demo_dual_imports.py`
+- Demonstration script showing how dual imports work
+- Shows usage examples for both import styles
+- Provides migration guide for users
+- Verifies package structure and configuration
+
+## Running the Tests
+
+### From the project root:
+```bash
+# Run minimal structure tests (works in dev environment)
+python tests/reward_protocol_tests/test_minimal_structure.py
+
+# Run import equivalence tests (works in dev environment)
+python tests/reward_protocol_tests/test_import_equivalence.py
+
+# Run demo (works in dev environment)
+python tests/reward_protocol_tests/demo_dual_imports.py
+
+# Run simple tests (requires full installation)
+python tests/reward_protocol_tests/test_reward_protocol_simple.py
+
+# Run pytest tests (requires full installation)
+pytest tests/test_reward_protocol_import.py -v
+```
+
+## Purpose
+
+These tests verify that users can import the package using either:
+- `from reward_kit import ...` (original style)
+- `from reward_protocol import ...` (new style)
+
+Both import styles provide identical functionality with no breaking changes.