works-on-my-machine 2.6.8
Universal development tools for Python and JavaScript - Automatic installation, cross-platform configuration, global commands
License: MIT
Requires Python: >=3.9
Keywords: development-tools, python, javascript, automation, project-setup

# 🛠️ Works On My Machine (WOMM)

[![Python](https://img.shields.io/badge/Python-3.8+-blue.svg?style=for-the-badge&logo=python&logoColor=white)](https://python.org)
[![License](https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge)](LICENSE)
[![Version](https://img.shields.io/badge/Version-2.6.8-orange.svg?style=for-the-badge)](https://github.com/neuraaak/works-on-my-machine)
[![Platform](https://img.shields.io/badge/Platform-Windows%20%7C%20macOS%20%7C%20Linux-lightgrey.svg?style=for-the-badge)](https://github.com/neuraaak/works-on-my-machine)
[![Status](https://img.shields.io/badge/Status-Beta-yellow.svg?style=for-the-badge)](https://github.com/neuraaak/works-on-my-machine)

[![Tests](https://img.shields.io/badge/Tests-TODO-orange.svg?style=flat-square)](https://github.com/neuraaak/works-on-my-machine)
[![Documentation](https://img.shields.io/badge/Documentation-Complete-blue.svg?style=flat-square)](docs/README.md)
[![Maintenance](https://img.shields.io/badge/Maintenance-Active-brightgreen.svg?style=flat-square)](https://github.com/neuraaak/works-on-my-machine)

> **Universal development environment manager for Python and JavaScript**  
> 🚀 **One command to rule them all** - Automatic setup, cross-platform configuration, professional tooling

---

## 🎯 What is WOMM?

**Works On My Machine** is a comprehensive development environment manager that eliminates the "it works on my machine" problem. It provides a unified CLI tool that automatically sets up professional development environments for Python and JavaScript projects.

### ✨ **Key Features**

- 🚀 **One-Command Setup** - Complete project initialization with professional tooling
- 🔧 **Cross-Platform** - Works seamlessly on Windows, macOS, and Linux
- 🎯 **Smart Detection** - Automatically detects project types and applies appropriate configurations
- 📦 **Template System** - Create reusable project templates from existing projects
- 🛠️ **Professional Tooling** - Pre-configured with industry-standard tools (Black, ESLint, Prettier, etc.)
- 🔄 **Interactive Mode** - Guided setup with beautiful CLI interfaces
- 📚 **Comprehensive Documentation** - Complete guides for every feature

---

## 🚀 Quick Start

### **Installation**

```bash
# Option 1: Install from PyPI (recommended)
pip install works-on-my-machine
# OR
pip install womm

# Option 2: Install from source
git clone https://github.com/neuraaak/works-on-my-machine.git
cd works-on-my-machine
python womm.py install

# Restart your terminal, then use WOMM anywhere!
```

### **Create Your First Project**

```bash
# Create a Python project with full tooling
womm new python my-awesome-app

# Create a JavaScript/React project
womm new javascript my-react-app

# Let WOMM detect and setup automatically
womm new detect my-project
```

### **Setup Existing Projects**

```bash
# Setup Python project with professional tooling
womm setup python

# Setup JavaScript project with ESLint, Prettier, etc.
womm setup javascript

# Auto-detect and setup
womm setup detect
```

---

## 🎯 Available Commands

### **🆕 Project Creation**

```bash
womm new python <name>     # Create Python project with virtual env, Black, pytest
womm new javascript <name> # Create JavaScript project with ESLint, Prettier
womm new detect <name>     # Auto-detect project type and create
womm new --interactive     # Guided project creation
```

### **⚙️ Project Setup**

```bash
womm setup python          # Setup Python project (dependencies, tools, config)
womm setup javascript      # Setup JavaScript project (npm, ESLint, etc.)
womm setup detect          # Auto-detect and setup project
womm setup --interactive   # Guided setup process
```

### **🔍 Code Quality**

```bash
womm lint python           # Lint Python code (Black, isort, flake8)
womm lint javascript       # Lint JavaScript code (ESLint, Prettier)
womm lint all              # Lint all supported code in project
womm spell check           # Check spelling in project files
```

### **📦 Template Management**

```bash
womm template create       # Create template from current project
womm template list         # List available templates
womm template info <name>  # Show template details
womm template delete <name> # Delete template
```

### **🔧 System Management**

```bash
womm system detect         # Detect system information and tools
womm system install <tools> # Install prerequisites (python, node, git)
womm install               # Install WOMM globally
womm uninstall             # Remove WOMM from system
```

### **🖱️ Windows Integration**

```bash
womm context register      # Register WOMM in Windows context menu
womm context unregister    # Remove from context menu
womm context list          # List registered entries
```

---

## 🏗️ What WOMM Sets Up

### **🐍 Python Projects**

- ✅ **Virtual Environment** with `venv`
- ✅ **Code Formatting** with Black and isort
- ✅ **Linting** with flake8 and ruff
- ✅ **Testing** with pytest and coverage
- ✅ **Pre-commit Hooks** for quality assurance
- ✅ **VSCode Configuration** for consistent development
- ✅ **pyproject.toml** with modern Python packaging
- ✅ **Development Scripts** for common tasks

### **🟨 JavaScript Projects**

- ✅ **Package Management** with npm/yarn
- ✅ **Code Formatting** with Prettier
- ✅ **Linting** with ESLint
- ✅ **Testing** with Jest
- ✅ **Git Hooks** with Husky
- ✅ **VSCode Configuration** for JavaScript development
- ✅ **TypeScript Support** (optional)
- ✅ **Modern ES6+ Configuration**

### **🔧 Professional Tooling**

- ✅ **Cross-Platform Compatibility**
- ✅ **Consistent Code Style** across team
- ✅ **Automated Quality Checks**
- ✅ **Integrated Development Environment**
- ✅ **Best Practices** out of the box

---

## 📚 Documentation

### **📖 [Complete Documentation](docs/README.md)**

- **📋 [CLI Commands](docs/cli/README.md)** - All available commands and options
- **🐍 [Python Guide](docs/cli/NEW.md)** - Python project creation and setup
- **🟨 [JavaScript Guide](docs/cli/SETUP.md)** - JavaScript project setup
- **📦 [Templates](docs/cli/TEMPLATES.md)** - Template management system
- **🔧 [Installation](docs/cli/INSTALL.md)** - Installation and configuration
- **🛠️ [System Tools](docs/cli/SYSTEM.md)** - System detection and management

### **🔌 [API Reference](docs/api/README.md)**

- **🏗️ [Architecture](docs/api/ARCHITECTURE.md)** - Technical architecture overview
- **📦 [Templates API](docs/api/TEMPLATES_REFERENCE.md)** - Template system reference

---

## 🎯 Use Cases

### **👨‍💻 Individual Developers**

- **Quick Project Setup** - Start coding in minutes, not hours
- **Consistent Environments** - Same setup across all your machines
- **Professional Standards** - Industry-standard tooling without the hassle

### **👥 Development Teams**

- **Standardized Workflows** - Everyone uses the same tools and configurations
- **Onboarding** - New team members can start contributing immediately
- **Quality Assurance** - Automated code quality checks for all projects

### **🏢 Organizations**

- **Template Library** - Create and share project templates across teams
- **Best Practices** - Enforce coding standards and development workflows
- **Cross-Platform** - Works consistently across Windows, macOS, and Linux

---

## 🛠️ Technical Architecture

### **Core Components**

- **CLI Interface** - Modern Click-based command-line interface
- **Project Managers** - Language-specific project creation and setup
- **Template System** - Dynamic template generation and management
- **System Detection** - Automatic detection of tools and environments
- **UI Components** - Rich terminal interfaces with progress tracking

### **Supported Platforms**

- **Windows** - Full support with batch scripts and PowerShell
- **macOS** - Native Unix-like environment support
- **Linux** - Complete compatibility with various distributions

### **Language Support**

- **Python** - 3.8+ with modern tooling ecosystem
- **JavaScript** - Node.js with modern development tools
- **Extensible** - Framework for adding more languages

---

## 🤝 Contributing

We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.

### **Development Setup**

```bash
# Clone and setup development environment
git clone https://github.com/neuraaak/works-on-my-machine.git
cd works-on-my-machine

# Install in development mode
pip install -e .

# Run tests
pytest

# Run linting
womm lint python
```

---

## 📄 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

---

## 🙏 Acknowledgments

- **Click** - For the excellent CLI framework
- **Rich** - For beautiful terminal interfaces
- **InquirerPy** - For interactive command-line prompts
- **Black, ESLint, Prettier** - For code quality tools
- **The Python and JavaScript communities** - For amazing development tools

---

## 📊 Project Status

- **Version**: 2.6.8
- **Status**: Beta (actively maintained)
- **Python Support**: 3.8+
- **Platforms**: Windows, macOS, Linux
- **Languages**: Python, JavaScript

---

**Made with ❤️ by the WOMM Team**

_"It works on my machine, and now it will work on yours too!"_ 🚀