# 🛠️ Works On My Machine (WOMM)
[](https://python.org)
[](LICENSE)
[](https://github.com/neuraaak/works-on-my-machine)
[](https://github.com/neuraaak/works-on-my-machine)
[](https://github.com/neuraaak/works-on-my-machine)
[](https://github.com/neuraaak/works-on-my-machine)
[](docs/README.md)
[](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!"_ 🚀
Raw data
{
"_id": null,
"home_page": "https://github.com/neuraaak/works-on-my-machine",
"name": "works-on-my-machine",
"maintainer": "Neuraaak",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "development-tools, python, javascript, automation, project-setup",
"author": "Neuraaak",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/39/1a/15947a4f9ba96f8c0e872f26fff3049ff32f62f922f862751805b1dc38f0/works_on_my_machine-2.6.8.tar.gz",
"platform": null,
"description": "# \ud83d\udee0\ufe0f Works On My Machine (WOMM)\r\n\r\n[](https://python.org)\r\n[](LICENSE)\r\n[](https://github.com/neuraaak/works-on-my-machine)\r\n[](https://github.com/neuraaak/works-on-my-machine)\r\n[](https://github.com/neuraaak/works-on-my-machine)\r\n\r\n[](https://github.com/neuraaak/works-on-my-machine)\r\n[](docs/README.md)\r\n[](https://github.com/neuraaak/works-on-my-machine)\r\n\r\n> **Universal development environment manager for Python and JavaScript** \r\n> \ud83d\ude80 **One command to rule them all** - Automatic setup, cross-platform configuration, professional tooling\r\n\r\n---\r\n\r\n## \ud83c\udfaf What is WOMM?\r\n\r\n**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.\r\n\r\n### \u2728 **Key Features**\r\n\r\n- \ud83d\ude80 **One-Command Setup** - Complete project initialization with professional tooling\r\n- \ud83d\udd27 **Cross-Platform** - Works seamlessly on Windows, macOS, and Linux\r\n- \ud83c\udfaf **Smart Detection** - Automatically detects project types and applies appropriate configurations\r\n- \ud83d\udce6 **Template System** - Create reusable project templates from existing projects\r\n- \ud83d\udee0\ufe0f **Professional Tooling** - Pre-configured with industry-standard tools (Black, ESLint, Prettier, etc.)\r\n- \ud83d\udd04 **Interactive Mode** - Guided setup with beautiful CLI interfaces\r\n- \ud83d\udcda **Comprehensive Documentation** - Complete guides for every feature\r\n\r\n---\r\n\r\n## \ud83d\ude80 Quick Start\r\n\r\n### **Installation**\r\n\r\n```bash\r\n# Option 1: Install from PyPI (recommended)\r\npip install works-on-my-machine\r\n# OR\r\npip install womm\r\n\r\n# Option 2: Install from source\r\ngit clone https://github.com/neuraaak/works-on-my-machine.git\r\ncd works-on-my-machine\r\npython womm.py install\r\n\r\n# Restart your terminal, then use WOMM anywhere!\r\n```\r\n\r\n### **Create Your First Project**\r\n\r\n```bash\r\n# Create a Python project with full tooling\r\nwomm new python my-awesome-app\r\n\r\n# Create a JavaScript/React project\r\nwomm new javascript my-react-app\r\n\r\n# Let WOMM detect and setup automatically\r\nwomm new detect my-project\r\n```\r\n\r\n### **Setup Existing Projects**\r\n\r\n```bash\r\n# Setup Python project with professional tooling\r\nwomm setup python\r\n\r\n# Setup JavaScript project with ESLint, Prettier, etc.\r\nwomm setup javascript\r\n\r\n# Auto-detect and setup\r\nwomm setup detect\r\n```\r\n\r\n---\r\n\r\n## \ud83c\udfaf Available Commands\r\n\r\n### **\ud83c\udd95 Project Creation**\r\n\r\n```bash\r\nwomm new python <name> # Create Python project with virtual env, Black, pytest\r\nwomm new javascript <name> # Create JavaScript project with ESLint, Prettier\r\nwomm new detect <name> # Auto-detect project type and create\r\nwomm new --interactive # Guided project creation\r\n```\r\n\r\n### **\u2699\ufe0f Project Setup**\r\n\r\n```bash\r\nwomm setup python # Setup Python project (dependencies, tools, config)\r\nwomm setup javascript # Setup JavaScript project (npm, ESLint, etc.)\r\nwomm setup detect # Auto-detect and setup project\r\nwomm setup --interactive # Guided setup process\r\n```\r\n\r\n### **\ud83d\udd0d Code Quality**\r\n\r\n```bash\r\nwomm lint python # Lint Python code (Black, isort, flake8)\r\nwomm lint javascript # Lint JavaScript code (ESLint, Prettier)\r\nwomm lint all # Lint all supported code in project\r\nwomm spell check # Check spelling in project files\r\n```\r\n\r\n### **\ud83d\udce6 Template Management**\r\n\r\n```bash\r\nwomm template create # Create template from current project\r\nwomm template list # List available templates\r\nwomm template info <name> # Show template details\r\nwomm template delete <name> # Delete template\r\n```\r\n\r\n### **\ud83d\udd27 System Management**\r\n\r\n```bash\r\nwomm system detect # Detect system information and tools\r\nwomm system install <tools> # Install prerequisites (python, node, git)\r\nwomm install # Install WOMM globally\r\nwomm uninstall # Remove WOMM from system\r\n```\r\n\r\n### **\ud83d\uddb1\ufe0f Windows Integration**\r\n\r\n```bash\r\nwomm context register # Register WOMM in Windows context menu\r\nwomm context unregister # Remove from context menu\r\nwomm context list # List registered entries\r\n```\r\n\r\n---\r\n\r\n## \ud83c\udfd7\ufe0f What WOMM Sets Up\r\n\r\n### **\ud83d\udc0d Python Projects**\r\n\r\n- \u2705 **Virtual Environment** with `venv`\r\n- \u2705 **Code Formatting** with Black and isort\r\n- \u2705 **Linting** with flake8 and ruff\r\n- \u2705 **Testing** with pytest and coverage\r\n- \u2705 **Pre-commit Hooks** for quality assurance\r\n- \u2705 **VSCode Configuration** for consistent development\r\n- \u2705 **pyproject.toml** with modern Python packaging\r\n- \u2705 **Development Scripts** for common tasks\r\n\r\n### **\ud83d\udfe8 JavaScript Projects**\r\n\r\n- \u2705 **Package Management** with npm/yarn\r\n- \u2705 **Code Formatting** with Prettier\r\n- \u2705 **Linting** with ESLint\r\n- \u2705 **Testing** with Jest\r\n- \u2705 **Git Hooks** with Husky\r\n- \u2705 **VSCode Configuration** for JavaScript development\r\n- \u2705 **TypeScript Support** (optional)\r\n- \u2705 **Modern ES6+ Configuration**\r\n\r\n### **\ud83d\udd27 Professional Tooling**\r\n\r\n- \u2705 **Cross-Platform Compatibility**\r\n- \u2705 **Consistent Code Style** across team\r\n- \u2705 **Automated Quality Checks**\r\n- \u2705 **Integrated Development Environment**\r\n- \u2705 **Best Practices** out of the box\r\n\r\n---\r\n\r\n## \ud83d\udcda Documentation\r\n\r\n### **\ud83d\udcd6 [Complete Documentation](docs/README.md)**\r\n\r\n- **\ud83d\udccb [CLI Commands](docs/cli/README.md)** - All available commands and options\r\n- **\ud83d\udc0d [Python Guide](docs/cli/NEW.md)** - Python project creation and setup\r\n- **\ud83d\udfe8 [JavaScript Guide](docs/cli/SETUP.md)** - JavaScript project setup\r\n- **\ud83d\udce6 [Templates](docs/cli/TEMPLATES.md)** - Template management system\r\n- **\ud83d\udd27 [Installation](docs/cli/INSTALL.md)** - Installation and configuration\r\n- **\ud83d\udee0\ufe0f [System Tools](docs/cli/SYSTEM.md)** - System detection and management\r\n\r\n### **\ud83d\udd0c [API Reference](docs/api/README.md)**\r\n\r\n- **\ud83c\udfd7\ufe0f [Architecture](docs/api/ARCHITECTURE.md)** - Technical architecture overview\r\n- **\ud83d\udce6 [Templates API](docs/api/TEMPLATES_REFERENCE.md)** - Template system reference\r\n\r\n---\r\n\r\n## \ud83c\udfaf Use Cases\r\n\r\n### **\ud83d\udc68\u200d\ud83d\udcbb Individual Developers**\r\n\r\n- **Quick Project Setup** - Start coding in minutes, not hours\r\n- **Consistent Environments** - Same setup across all your machines\r\n- **Professional Standards** - Industry-standard tooling without the hassle\r\n\r\n### **\ud83d\udc65 Development Teams**\r\n\r\n- **Standardized Workflows** - Everyone uses the same tools and configurations\r\n- **Onboarding** - New team members can start contributing immediately\r\n- **Quality Assurance** - Automated code quality checks for all projects\r\n\r\n### **\ud83c\udfe2 Organizations**\r\n\r\n- **Template Library** - Create and share project templates across teams\r\n- **Best Practices** - Enforce coding standards and development workflows\r\n- **Cross-Platform** - Works consistently across Windows, macOS, and Linux\r\n\r\n---\r\n\r\n## \ud83d\udee0\ufe0f Technical Architecture\r\n\r\n### **Core Components**\r\n\r\n- **CLI Interface** - Modern Click-based command-line interface\r\n- **Project Managers** - Language-specific project creation and setup\r\n- **Template System** - Dynamic template generation and management\r\n- **System Detection** - Automatic detection of tools and environments\r\n- **UI Components** - Rich terminal interfaces with progress tracking\r\n\r\n### **Supported Platforms**\r\n\r\n- **Windows** - Full support with batch scripts and PowerShell\r\n- **macOS** - Native Unix-like environment support\r\n- **Linux** - Complete compatibility with various distributions\r\n\r\n### **Language Support**\r\n\r\n- **Python** - 3.8+ with modern tooling ecosystem\r\n- **JavaScript** - Node.js with modern development tools\r\n- **Extensible** - Framework for adding more languages\r\n\r\n---\r\n\r\n## \ud83e\udd1d Contributing\r\n\r\nWe welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.\r\n\r\n### **Development Setup**\r\n\r\n```bash\r\n# Clone and setup development environment\r\ngit clone https://github.com/neuraaak/works-on-my-machine.git\r\ncd works-on-my-machine\r\n\r\n# Install in development mode\r\npip install -e .\r\n\r\n# Run tests\r\npytest\r\n\r\n# Run linting\r\nwomm lint python\r\n```\r\n\r\n---\r\n\r\n## \ud83d\udcc4 License\r\n\r\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\r\n\r\n---\r\n\r\n## \ud83d\ude4f Acknowledgments\r\n\r\n- **Click** - For the excellent CLI framework\r\n- **Rich** - For beautiful terminal interfaces\r\n- **InquirerPy** - For interactive command-line prompts\r\n- **Black, ESLint, Prettier** - For code quality tools\r\n- **The Python and JavaScript communities** - For amazing development tools\r\n\r\n---\r\n\r\n## \ud83d\udcca Project Status\r\n\r\n- **Version**: 2.6.8\r\n- **Status**: Beta (actively maintained)\r\n- **Python Support**: 3.8+\r\n- **Platforms**: Windows, macOS, Linux\r\n- **Languages**: Python, JavaScript\r\n\r\n---\r\n\r\n**Made with \u2764\ufe0f by the WOMM Team**\r\n\r\n_\"It works on my machine, and now it will work on yours too!\"_ \ud83d\ude80\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Universal development tools for Python and JavaScript - Automatic installation, cross-platform configuration, global commands",
"version": "2.6.8",
"project_urls": {
"Bug Tracker": "https://github.com/neuraaak/works-on-my-machine/issues",
"Homepage": "https://github.com/neuraaak/works-on-my-machine",
"Repository": "https://github.com/neuraaak/works-on-my-machine"
},
"split_keywords": [
"development-tools",
" python",
" javascript",
" automation",
" project-setup"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "24e803e65e3d0569ebae055863592fc4addf5b8a64b2af99ccb70f6e567a6a39",
"md5": "39503c78b3069153588b68e77b59c3dd",
"sha256": "e0beda7fdaba8a690e7207448220706927fd5d25dad60eba10731b2b9e6c5e77"
},
"downloads": -1,
"filename": "works_on_my_machine-2.6.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "39503c78b3069153588b68e77b59c3dd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 281070,
"upload_time": "2025-08-27T22:15:17",
"upload_time_iso_8601": "2025-08-27T22:15:17.761148Z",
"url": "https://files.pythonhosted.org/packages/24/e8/03e65e3d0569ebae055863592fc4addf5b8a64b2af99ccb70f6e567a6a39/works_on_my_machine-2.6.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "391a15947a4f9ba96f8c0e872f26fff3049ff32f62f922f862751805b1dc38f0",
"md5": "036f0a896b503bf9bcb4c781f07a7f8f",
"sha256": "f525f3e41b36f98fc996d64581c69a8ed70b742b40525651e6517319d4ebb722"
},
"downloads": -1,
"filename": "works_on_my_machine-2.6.8.tar.gz",
"has_sig": false,
"md5_digest": "036f0a896b503bf9bcb4c781f07a7f8f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 216099,
"upload_time": "2025-08-27T22:15:18",
"upload_time_iso_8601": "2025-08-27T22:15:18.853242Z",
"url": "https://files.pythonhosted.org/packages/39/1a/15947a4f9ba96f8c0e872f26fff3049ff32f62f922f862751805b1dc38f0/works_on_my_machine-2.6.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-27 22:15:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "neuraaak",
"github_project": "works-on-my-machine",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "works-on-my-machine"
}
JSON
