mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-29 16:16:08 +00:00
## Version Management & Consistency - Update to version 4.0.0b1 (proper beta versioning for PyPI) - Add __version__ attribute to SuperClaude/__init__.py - Ensure version consistency across pyproject.toml, __main__.py, setup/__init__.py ## Enhanced Package Configuration - Improve pyproject.toml with comprehensive PyPI classifiers - Add proper license specification and enhanced metadata - Configure package discovery with inclusion/exclusion patterns - Add development and test dependencies ## Publishing Scripts & Tools - scripts/build_and_upload.py: Advanced Python script for building and uploading - scripts/publish.sh: User-friendly shell wrapper for common operations - scripts/validate_pypi_ready.py: Comprehensive validation and readiness checker - All scripts executable with proper error handling and validation ## GitHub Actions Automation - .github/workflows/publish-pypi.yml: Complete CI/CD pipeline - Automatic publishing on GitHub releases - Manual workflow dispatch for TestPyPI uploads - Package validation and installation testing ## Documentation & Security - PUBLISHING.md: Comprehensive PyPI publishing guide - scripts/README.md: Detailed script usage documentation - .env.example: Environment variable template - Secure token handling with both .pypirc and environment variables ## Features ✅ Version consistency validation across all files ✅ Comprehensive PyPI metadata and classifiers ✅ Multi-environment publishing (TestPyPI + PyPI) ✅ Automated GitHub Actions workflow ✅ Security best practices for API token handling ✅ Complete documentation and troubleshooting guides ✅ Enterprise-grade validation and error handling The SuperClaude Framework is now fully prepared for PyPI publication with professional-grade automation, validation, and documentation. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
255 lines
8.7 KiB
Python
255 lines
8.7 KiB
Python
#!/usr/bin/env python3
|
|
"""
|
|
SuperClaude Framework Management Hub
|
|
Unified entry point for all SuperClaude operations
|
|
|
|
Usage:
|
|
SuperClaude install [options]
|
|
SuperClaude update [options]
|
|
SuperClaude uninstall [options]
|
|
SuperClaude backup [options]
|
|
SuperClaude --help
|
|
"""
|
|
|
|
import sys
|
|
import argparse
|
|
import subprocess
|
|
import difflib
|
|
from pathlib import Path
|
|
from typing import Dict, Callable
|
|
|
|
# Add the 'setup' directory to the Python import path (with deprecation-safe logic)
|
|
|
|
try:
|
|
# Python 3.9+ preferred modern way
|
|
from importlib.resources import files, as_file
|
|
with as_file(files("setup")) as resource:
|
|
setup_dir = str(resource)
|
|
except (ImportError, ModuleNotFoundError, AttributeError):
|
|
# Fallback for Python < 3.9
|
|
from pkg_resources import resource_filename
|
|
setup_dir = resource_filename('setup', '')
|
|
|
|
# Add to sys.path
|
|
sys.path.insert(0, str(setup_dir))
|
|
|
|
|
|
# Try to import utilities from the setup package
|
|
try:
|
|
from setup.utils.ui import (
|
|
display_header, display_info, display_success, display_error,
|
|
display_warning, Colors
|
|
)
|
|
from setup.utils.logger import setup_logging, get_logger, LogLevel
|
|
from setup import DEFAULT_INSTALL_DIR
|
|
except ImportError:
|
|
# Provide minimal fallback functions and constants if imports fail
|
|
class Colors:
|
|
RED = YELLOW = GREEN = CYAN = RESET = ""
|
|
|
|
def display_error(msg): print(f"[ERROR] {msg}")
|
|
def display_warning(msg): print(f"[WARN] {msg}")
|
|
def display_success(msg): print(f"[OK] {msg}")
|
|
def display_info(msg): print(f"[INFO] {msg}")
|
|
def display_header(title, subtitle): print(f"{title} - {subtitle}")
|
|
def get_logger(): return None
|
|
def setup_logging(*args, **kwargs): pass
|
|
class LogLevel:
|
|
ERROR = 40
|
|
INFO = 20
|
|
DEBUG = 10
|
|
|
|
|
|
def create_global_parser() -> argparse.ArgumentParser:
|
|
"""Create shared parser for global flags used by all commands"""
|
|
global_parser = argparse.ArgumentParser(add_help=False)
|
|
|
|
global_parser.add_argument("--verbose", "-v", action="store_true",
|
|
help="Enable verbose logging")
|
|
global_parser.add_argument("--quiet", "-q", action="store_true",
|
|
help="Suppress all output except errors")
|
|
global_parser.add_argument("--install-dir", type=Path, default=DEFAULT_INSTALL_DIR,
|
|
help=f"Target installation directory (default: {DEFAULT_INSTALL_DIR})")
|
|
global_parser.add_argument("--dry-run", action="store_true",
|
|
help="Simulate operation without making changes")
|
|
global_parser.add_argument("--force", action="store_true",
|
|
help="Force execution, skipping checks")
|
|
global_parser.add_argument("--yes", "-y", action="store_true",
|
|
help="Automatically answer yes to all prompts")
|
|
|
|
return global_parser
|
|
|
|
|
|
def create_parser():
|
|
"""Create the main CLI parser and attach subcommand parsers"""
|
|
global_parser = create_global_parser()
|
|
|
|
parser = argparse.ArgumentParser(
|
|
prog="SuperClaude",
|
|
description="SuperClaude Framework Management Hub - Unified CLI",
|
|
epilog="""
|
|
Examples:
|
|
SuperClaude install --dry-run
|
|
SuperClaude update --verbose
|
|
SuperClaude backup --create
|
|
""",
|
|
formatter_class=argparse.RawDescriptionHelpFormatter,
|
|
parents=[global_parser]
|
|
)
|
|
|
|
parser.add_argument("--version", action="version", version="SuperClaude 4.0.0b1")
|
|
|
|
subparsers = parser.add_subparsers(
|
|
dest="operation",
|
|
title="Operations",
|
|
description="Framework operations to perform"
|
|
)
|
|
|
|
return parser, subparsers, global_parser
|
|
|
|
|
|
def setup_global_environment(args: argparse.Namespace):
|
|
"""Set up logging and shared runtime environment based on args"""
|
|
# Determine log level
|
|
if args.quiet:
|
|
level = LogLevel.ERROR
|
|
elif args.verbose:
|
|
level = LogLevel.DEBUG
|
|
else:
|
|
level = LogLevel.INFO
|
|
|
|
# Define log directory unless it's a dry run
|
|
log_dir = args.install_dir / "logs" if not args.dry_run else None
|
|
setup_logging("superclaude_hub", log_dir=log_dir, console_level=level)
|
|
|
|
# Log startup context
|
|
logger = get_logger()
|
|
if logger:
|
|
logger.debug(f"SuperClaude called with operation: {getattr(args, 'operation', 'None')}")
|
|
logger.debug(f"Arguments: {vars(args)}")
|
|
|
|
|
|
def get_operation_modules() -> Dict[str, str]:
|
|
"""Return supported operations and their descriptions"""
|
|
return {
|
|
"install": "Install SuperClaude framework components",
|
|
"update": "Update existing SuperClaude installation",
|
|
"uninstall": "Remove SuperClaude installation",
|
|
"backup": "Backup and restore operations"
|
|
}
|
|
|
|
|
|
def load_operation_module(name: str):
|
|
"""Try to dynamically import an operation module"""
|
|
try:
|
|
return __import__(f"setup.cli.commands.{name}", fromlist=[name])
|
|
except ImportError as e:
|
|
logger = get_logger()
|
|
if logger:
|
|
logger.error(f"Module '{name}' failed to load: {e}")
|
|
return None
|
|
|
|
|
|
def register_operation_parsers(subparsers, global_parser) -> Dict[str, Callable]:
|
|
"""Register subcommand parsers and map operation names to their run functions"""
|
|
operations = {}
|
|
for name, desc in get_operation_modules().items():
|
|
module = load_operation_module(name)
|
|
if module and hasattr(module, 'register_parser') and hasattr(module, 'run'):
|
|
module.register_parser(subparsers, global_parser)
|
|
operations[name] = module.run
|
|
else:
|
|
# If module doesn't exist, register a stub parser and fallback to legacy
|
|
parser = subparsers.add_parser(name, help=f"{desc} (legacy fallback)", parents=[global_parser])
|
|
parser.add_argument("--legacy", action="store_true", help="Use legacy script")
|
|
operations[name] = None
|
|
return operations
|
|
|
|
|
|
def handle_legacy_fallback(op: str, args: argparse.Namespace) -> int:
|
|
"""Run a legacy operation script if module is unavailable"""
|
|
script_path = Path(__file__).parent / f"{op}.py"
|
|
|
|
if not script_path.exists():
|
|
display_error(f"No module or legacy script found for operation '{op}'")
|
|
return 1
|
|
|
|
display_warning(f"Falling back to legacy script for '{op}'...")
|
|
|
|
cmd = [sys.executable, str(script_path)]
|
|
|
|
# Convert args into CLI flags
|
|
for k, v in vars(args).items():
|
|
if k in ['operation', 'install_dir'] or v in [None, False]:
|
|
continue
|
|
flag = f"--{k.replace('_', '-')}"
|
|
if v is True:
|
|
cmd.append(flag)
|
|
else:
|
|
cmd.extend([flag, str(v)])
|
|
|
|
try:
|
|
return subprocess.call(cmd)
|
|
except Exception as e:
|
|
display_error(f"Legacy execution failed: {e}")
|
|
return 1
|
|
|
|
|
|
def main() -> int:
|
|
"""Main entry point"""
|
|
try:
|
|
parser, subparsers, global_parser = create_parser()
|
|
operations = register_operation_parsers(subparsers, global_parser)
|
|
args = parser.parse_args()
|
|
|
|
# No operation provided? Show help manually unless in quiet mode
|
|
if not args.operation:
|
|
if not args.quiet:
|
|
display_header("SuperClaude Framework v4.0.0-beta", "Unified CLI for all operations")
|
|
print(f"{Colors.CYAN}Available operations:{Colors.RESET}")
|
|
for op, desc in get_operation_modules().items():
|
|
print(f" {op:<12} {desc}")
|
|
return 0
|
|
|
|
# Handle unknown operations and suggest corrections
|
|
if args.operation not in operations:
|
|
close = difflib.get_close_matches(args.operation, operations.keys(), n=1)
|
|
suggestion = f"Did you mean: {close[0]}?" if close else ""
|
|
display_error(f"Unknown operation: '{args.operation}'. {suggestion}")
|
|
return 1
|
|
|
|
# Setup global context (logging, install path, etc.)
|
|
setup_global_environment(args)
|
|
logger = get_logger()
|
|
|
|
# Execute operation
|
|
run_func = operations.get(args.operation)
|
|
if run_func:
|
|
if logger:
|
|
logger.info(f"Executing operation: {args.operation}")
|
|
return run_func(args)
|
|
else:
|
|
# Fallback to legacy script
|
|
if logger:
|
|
logger.warning(f"Module for '{args.operation}' missing, using legacy fallback")
|
|
return handle_legacy_fallback(args.operation, args)
|
|
|
|
except KeyboardInterrupt:
|
|
print(f"\n{Colors.YELLOW}Operation cancelled by user{Colors.RESET}")
|
|
return 130
|
|
except Exception as e:
|
|
try:
|
|
logger = get_logger()
|
|
if logger:
|
|
logger.exception(f"Unhandled error: {e}")
|
|
except:
|
|
print(f"{Colors.RED}[ERROR] {e}{Colors.RESET}")
|
|
return 1
|
|
|
|
|
|
# Entrypoint guard
|
|
if __name__ == "__main__":
|
|
sys.exit(main())
|
|
|
|
|