SuperClaude/scripts/validate_pypi_ready.py
kazuki nakai 050d5ea2ab
refactor: PEP8 compliance - directory rename and code formatting (#425)
* fix(orchestration): add WebFetch auto-trigger for infrastructure configuration

Problem: Infrastructure configuration changes (e.g., Traefik port settings)
were being made based on assumptions without consulting official documentation,
violating the 'Evidence > assumptions' principle in PRINCIPLES.md.

Solution:
- Added Infrastructure Configuration Validation section to MODE_Orchestration.md
- Auto-triggers WebFetch for infrastructure tools (Traefik, nginx, Docker, etc.)
- Enforces MODE_DeepResearch activation for investigation
- BLOCKS assumption-based configuration changes

Testing: Verified WebFetch successfully retrieves Traefik official docs (port 80 default)

This prevents production outages from infrastructure misconfiguration by ensuring
all technical recommendations are backed by official documentation.

* feat: Add PM Agent (Project Manager Agent) for seamless orchestration

Introduces PM Agent as the default orchestration layer that coordinates
all sub-agents and manages workflows automatically.

Key Features:
- Default orchestration: All user interactions handled by PM Agent
- Auto-delegation: Intelligent sub-agent selection based on task analysis
- Docker Gateway integration: Zero-token baseline with dynamic MCP loading
- Self-improvement loop: Automatic documentation of patterns and mistakes
- Optional override: Users can specify sub-agents explicitly if desired

Architecture:
- Agent spec: SuperClaude/Agents/pm-agent.md
- Command: SuperClaude/Commands/pm.md
- Updated docs: README.md (15→16 agents), agents.md (new Orchestration category)

User Experience:
- Default: PM Agent handles everything (seamless, no manual routing)
- Optional: Explicit --agent flag for direct sub-agent access
- Both modes available simultaneously (no user downside)

Implementation Status:
-  Specification complete
-  Documentation complete
-  Prototype implementation needed
-  Docker Gateway integration needed
-  Testing and validation needed

Refs: kazukinakai/docker-mcp-gateway (IRIS MCP Gateway integration)

* feat: Add Agent Orchestration rules for PM Agent default activation

Implements PM Agent as the default orchestration layer in RULES.md.

Key Changes:
- New 'Agent Orchestration' section (CRITICAL priority)
- PM Agent receives ALL user requests by default
- Manual override with @agent-[name] bypasses PM Agent
- Agent Selection Priority clearly defined:
  1. Manual override → Direct routing
  2. Default → PM Agent → Auto-delegation
  3. Delegation based on keywords, file types, complexity, context

User Experience:
- Default: PM Agent handles everything (seamless)
- Override: @agent-[name] for direct specialist access
- Transparent: PM Agent reports delegation decisions

This establishes PM Agent as the orchestration layer while
respecting existing auto-activation patterns and manual overrides.

Next Steps:
- Local testing in agiletec project
- Iteration based on actual behavior
- Documentation updates as needed

* refactor(pm-agent): redesign as self-improvement meta-layer

Problem Resolution:
PM Agent's initial design competed with existing auto-activation for task routing,
creating confusion about orchestration responsibilities and adding unnecessary complexity.

Design Change:
Redefined PM Agent as a meta-layer agent that operates AFTER specialist agents
complete tasks, focusing on:
- Post-implementation documentation and pattern recording
- Immediate mistake analysis with prevention checklists
- Monthly documentation maintenance and noise reduction
- Pattern extraction and knowledge synthesis

Two-Layer Orchestration System:
1. Task Execution Layer: Existing auto-activation handles task routing (unchanged)
2. Self-Improvement Layer: PM Agent meta-layer handles documentation (new)

Files Modified:
- SuperClaude/Agents/pm-agent.md: Complete rewrite with meta-layer design
  - Category: orchestration → meta
  - Triggers: All user interactions → Post-implementation, mistakes, monthly
  - Behavioral Mindset: Continuous learning system
  - Self-Improvement Workflow: BEFORE/DURING/AFTER/MISTAKE RECOVERY/MAINTENANCE

- SuperClaude/Core/RULES.md: Agent Orchestration section updated
  - Split into Task Execution Layer + Self-Improvement Layer
  - Added orchestration flow diagram
  - Clarified PM Agent activates AFTER task completion

- README.md: Updated PM Agent description
  - "orchestrates all interactions" → "ensures continuous learning"

- Docs/User-Guide/agents.md: PM Agent section rewritten
  - Section: Orchestration Agent → Meta-Layer Agent
  - Expertise: Project orchestration → Self-improvement workflow executor
  - Examples: Task coordination → Post-implementation documentation

- PR_DOCUMENTATION.md: Comprehensive PR documentation added
  - Summary, motivation, changes, testing, breaking changes
  - Two-layer orchestration system diagram
  - Verification checklist

Integration Validated:
Tested with agiletec project's self-improvement-workflow.md:
 PM Agent aligns with existing BEFORE/DURING/AFTER/MISTAKE RECOVERY phases
 Complements (not competes with) existing workflow
 agiletec workflow defines WHAT, PM Agent defines WHO executes it

Breaking Changes: None
- Existing auto-activation continues unchanged
- Specialist agents unaffected
- User workflows remain the same
- New capability: Automatic documentation and knowledge maintenance

Value Proposition:
Transforms SuperClaude into a continuously learning system that accumulates
knowledge, prevents recurring mistakes, and maintains fresh documentation
without manual intervention.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* docs: add Claude Code conversation history management research

Research covering .jsonl file structure, performance impact, and retention policies.

Content:
- Claude Code .jsonl file format and message types
- Performance issues from GitHub (memory leaks, conversation compaction)
- Retention policies (consumer vs enterprise)
- Rotation recommendations based on actual data
- File history snapshot tracking mechanics

Source: Moved from agiletec project (research applicable to all Claude Code projects)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* feat: add Development documentation structure

Phase 1: Documentation Structure complete

- Add Docs/Development/ directory for development documentation
- Add ARCHITECTURE.md - System architecture with PM Agent meta-layer
- Add ROADMAP.md - 5-phase development plan with checkboxes
- Add TASKS.md - Daily task tracking with progress indicators
- Add PROJECT_STATUS.md - Current status dashboard and metrics
- Add pm-agent-integration.md - Implementation guide for PM Agent mode

This establishes comprehensive documentation foundation for:
- System architecture understanding
- Development planning and tracking
- Implementation guidance
- Progress visibility

Related: #pm-agent-mode #documentation #phase-1

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* feat: PM Agent session lifecycle and PDCA implementation

Phase 2: PM Agent Mode Integration (Design Phase)

Commands/pm.md updates:
- Add "Always-Active Foundation Layer" concept
- Add Session Lifecycle (Session Start/During Work/Session End)
- Add PDCA Cycle (Plan/Do/Check/Act) automation
- Add Serena MCP Memory Integration (list/read/write_memory)
- Document auto-activation triggers

Agents/pm-agent.md updates:
- Add Session Start Protocol (MANDATORY auto-activation)
- Add During Work PDCA Cycle with example workflows
- Add Session End Protocol with state preservation
- Add PDCA Self-Evaluation Pattern
- Add Documentation Strategy (temp → patterns/mistakes)
- Add Memory Operations Reference

Key Features:
- Session start auto-activation for context restoration
- 30-minute checkpoint saves during work
- Self-evaluation with think_about_* operations
- Systematic documentation lifecycle
- Knowledge evolution to CLAUDE.md

Implementation Status:
-  Design complete (Commands/pm.md, Agents/pm-agent.md)
-  Implementation pending (Core components)
-  Serena MCP integration pending

Salvaged from mistaken development in ~/.claude directory

Related: #pm-agent-mode #session-lifecycle #pdca-cycle #phase-2

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* fix: disable Serena MCP auto-browser launch

Disable web dashboard and GUI log window auto-launch in Serena MCP server
to prevent intrusive browser popups on startup. Users can still manually
access the dashboard at http://localhost:24282/dashboard/ if needed.

Changes:
- Add CLI flags to Serena run command:
  - --enable-web-dashboard false
  - --enable-gui-log-window false
- Ensures Git-tracked configuration (no reliance on ~/.serena/serena_config.yml)
- Aligns with AIRIS MCP Gateway integration approach

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* refactor: rename directories to lowercase for PEP8 compliance

- Rename superclaude/Agents -> superclaude/agents
- Rename superclaude/Commands -> superclaude/commands
- Rename superclaude/Core -> superclaude/core
- Rename superclaude/Examples -> superclaude/examples
- Rename superclaude/MCP -> superclaude/mcp
- Rename superclaude/Modes -> superclaude/modes

This change follows Python PEP8 naming conventions for package directories.

* style: fix PEP8 violations and update package name to lowercase

Changes:
- Format all Python files with black (43 files reformatted)
- Update package name from 'SuperClaude' to 'superclaude' in pyproject.toml
- Fix import statements to use lowercase package name
- Add missing imports (timedelta, __version__)
- Remove old SuperClaude.egg-info directory

PEP8 violations reduced from 2672 to 701 (mostly E501 line length due to black's 88 char vs flake8's 79 char limit).

* docs: add PM Agent development documentation

Add comprehensive PM Agent development documentation:
- PM Agent ideal workflow (7-phase autonomous cycle)
- Project structure understanding (Git vs installed environment)
- Installation flow understanding (CommandsComponent behavior)
- Task management system (current-tasks.md)

Purpose: Eliminate repeated explanations and enable autonomous PDCA cycles

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* feat(pm-agent): add self-correcting execution and warning investigation culture

## Changes

### superclaude/commands/pm.md
- Add "Self-Correcting Execution" section with root cause analysis protocol
- Add "Warning/Error Investigation Culture" section enforcing zero-tolerance for dismissal
- Define error detection protocol: STOP → Investigate → Hypothesis → Different Solution → Execute
- Document anti-patterns (retry without understanding) and correct patterns (research-first)

### docs/Development/hypothesis-pm-autonomous-enhancement-2025-10-14.md
- Add PDCA workflow hypothesis document for PM Agent autonomous enhancement

## Rationale

PM Agent must never retry failed operations without understanding root causes.
All warnings and errors require investigation via context7/WebFetch/documentation
to ensure production-quality code and prevent technical debt accumulation.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* feat(installer): add airis-mcp-gateway MCP server option

## Changes

- Add airis-mcp-gateway to MCP server options in installer
- Configuration: GitHub-based installation via uvx
- Repository: https://github.com/oraios/airis-mcp-gateway
- Purpose: Dynamic MCP Gateway for zero-token baseline and on-demand tool loading

## Implementation

Added to setup/components/mcp.py self.mcp_servers dictionary with:
- install_method: github
- install_command: uvx test installation
- run_command: uvx runtime execution
- required: False (optional server)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

---------

Co-authored-by: kazuki <kazuki@kazukinoMacBook-Air.local>
Co-authored-by: Claude <noreply@anthropic.com>
2025-10-14 08:47:09 +05:30

232 lines
6.9 KiB
Python
Executable File

#!/usr/bin/env python3
"""
PyPI Readiness Validation Script
Checks if SuperClaude project is ready for PyPI publication
"""
import sys
import toml
from pathlib import Path
from typing import List, Tuple
# Project root
PROJECT_ROOT = Path(__file__).parent.parent
def check_file_exists(file_path: Path, description: str) -> bool:
"""Check if a required file exists"""
if file_path.exists():
print(f"{description}: {file_path}")
return True
else:
print(f"❌ Missing {description}: {file_path}")
return False
def check_version_consistency() -> bool:
"""Check if versions are consistent across files"""
print("\n🔍 Checking version consistency...")
versions = {}
# Check pyproject.toml
try:
pyproject_path = PROJECT_ROOT / "pyproject.toml"
with open(pyproject_path, "r") as f:
pyproject = toml.load(f)
versions["pyproject.toml"] = pyproject["project"]["version"]
print(f"📋 pyproject.toml version: {versions['pyproject.toml']}")
except Exception as e:
print(f"❌ Error reading pyproject.toml: {e}")
return False
# Check superclaude/__init__.py
try:
sys.path.insert(0, str(PROJECT_ROOT))
from superclaude import __version__
versions["superclaude/__init__.py"] = __version__
print(f"📦 Package version: {versions['superclaude/__init__.py']}")
except Exception as e:
print(f"❌ Error importing SuperClaude version: {e}")
return False
# Check setup/__init__.py
try:
from setup import __version__ as setup_version
versions["setup/__init__.py"] = setup_version
print(f"🔧 Setup version: {versions['setup/__init__.py']}")
except Exception as e:
print(f"❌ Error importing setup version: {e}")
return False
# Check consistency
all_versions = list(versions.values())
if len(set(all_versions)) == 1:
print(f"✅ All versions consistent: {all_versions[0]}")
return True
else:
print(f"❌ Version mismatch: {versions}")
return False
def check_package_structure() -> bool:
"""Check if package structure is correct"""
print("\n🏗️ Checking package structure...")
required_structure = [
("superclaude/__init__.py", "Main package __init__.py"),
("superclaude/__main__.py", "Main entry point"),
("superclaude/Core/__init__.py", "Core module __init__.py"),
("superclaude/Commands/__init__.py", "Commands module __init__.py"),
("superclaude/Agents/__init__.py", "Agents module __init__.py"),
("superclaude/Modes/__init__.py", "Modes module __init__.py"),
("superclaude/MCP/__init__.py", "MCP module __init__.py"),
("setup/__init__.py", "Setup package __init__.py"),
]
all_good = True
for file_path, description in required_structure:
full_path = PROJECT_ROOT / file_path
if not check_file_exists(full_path, description):
all_good = False
return all_good
def check_required_files() -> bool:
"""Check if all required files are present"""
print("\n📄 Checking required files...")
required_files = [
("pyproject.toml", "Package configuration"),
("README.md", "Project README"),
("LICENSE", "License file"),
("MANIFEST.in", "Package manifest"),
("setup.py", "Setup script"),
]
all_good = True
for file_path, description in required_files:
full_path = PROJECT_ROOT / file_path
if not check_file_exists(full_path, description):
all_good = False
return all_good
def check_pyproject_config() -> bool:
"""Check pyproject.toml configuration"""
print("\n⚙️ Checking pyproject.toml configuration...")
try:
pyproject_path = PROJECT_ROOT / "pyproject.toml"
with open(pyproject_path, "r") as f:
pyproject = toml.load(f)
project = pyproject.get("project", {})
# Required fields
required_fields = ["name", "version", "description", "authors"]
for field in required_fields:
if field in project:
print(f"{field}: {project[field]}")
else:
print(f"❌ Missing required field: {field}")
return False
# Check entry points
scripts = project.get("scripts", {})
if "superclaude" in scripts:
print(f"✅ CLI entry point: {scripts['superclaude']}")
else:
print("❌ Missing CLI entry point")
return False
# Check classifiers
classifiers = project.get("classifiers", [])
if len(classifiers) > 0:
print(f"{len(classifiers)} PyPI classifiers defined")
else:
print("⚠️ No PyPI classifiers defined")
return True
except Exception as e:
print(f"❌ Error reading pyproject.toml: {e}")
return False
def check_import_test() -> bool:
"""Test if the package can be imported"""
print("\n🧪 Testing package import...")
try:
sys.path.insert(0, str(PROJECT_ROOT))
import superclaude
print(f"✅ SuperClaude import successful")
print(f"📦 Version: {superclaude.__version__}")
print(f"👤 Author: {superclaude.__author__}")
return True
except Exception as e:
print(f"❌ Import failed: {e}")
return False
def main():
"""Main validation function"""
print("🔍 SuperClaude PyPI Readiness Validation")
print(f"📁 Project root: {PROJECT_ROOT}")
print("=" * 50)
checks = [
("Required Files", check_required_files),
("Package Structure", check_package_structure),
("Version Consistency", check_version_consistency),
("PyProject Configuration", check_pyproject_config),
("Import Test", check_import_test),
]
results = []
for name, check_func in checks:
try:
result = check_func()
results.append((name, result))
except Exception as e:
print(f"{name} check failed with exception: {e}")
results.append((name, False))
# Summary
print("\n" + "=" * 50)
print("📊 VALIDATION SUMMARY")
print("=" * 50)
passed = 0
total = len(results)
for name, result in results:
status = "✅ PASS" if result else "❌ FAIL"
print(f"{status} {name}")
if result:
passed += 1
print(f"\n📈 Overall: {passed}/{total} checks passed")
if passed == total:
print("🎉 Project is ready for PyPI publication!")
print("\nNext steps:")
print("1. ./scripts/publish.sh test # Test on TestPyPI")
print("2. ./scripts/publish.sh prod # Publish to PyPI")
return True
else:
print("❌ Project needs fixes before PyPI publication")
return False
if __name__ == "__main__":
success = main()
sys.exit(0 if success else 1)