flutter-setup 2.1.0__py3-none-any.whl

flutter_setup-2.1.0.dist-info/METADATA

@@ -0,0 +1,365 @@
+Metadata-Version: 2.4
+Name: flutter-setup
+Version: 2.1.0
+Summary: Flutter development environment setup CLI tool for macOS and Linux
+Author-email: Mark C Allen <mark@markcallen.com>
+License: MIT License
+        
+        Copyright (c) 2026 Mark Callen
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.3.2
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: rich>=15.0.0
+Requires-Dist: requests>=2.33.1
+Provides-Extra: dev
+Requires-Dist: black>=26.3.1; extra == "dev"
+Requires-Dist: mypy>=1.20.1; extra == "dev"
+Requires-Dist: pre-commit>=4.0.0; extra == "dev"
+Requires-Dist: ruff>=0.15.10; extra == "dev"
+Requires-Dist: pytest>=9.0.3; extra == "dev"
+Requires-Dist: pytest-cov>=7.1.0; extra == "dev"
+Requires-Dist: pytest-mock>=3.15.1; extra == "dev"
+Requires-Dist: types-pyyaml>=6.0.12.20250915; extra == "dev"
+Dynamic: license-file
+
+# Flutter Setup CLI
+
+A modern Python CLI tool for setting up complete Flutter development environments on macOS and Linux. This tool automates Flutter SDK setup, prerequisite checks, and project bootstrapping with practical defaults.
+
+## Features
+
+- 🚀 **Automated Setup**: Complete Flutter development environment setup in minutes
+- 🦋 **Flutter SDK Management**: Install, update, and manage Flutter SDK with multiple channels
+- 🛠️ **Prerequisites Installation**: Platform-aware prerequisite checks and installation flows for macOS and Linux
+- 📱 **Multi-Platform Support**: Create projects for iOS, Android, macOS, Linux, Windows, and Web
+- 🔧 **Development Environment**: Pre-configured VS Code/Cursor settings, testing framework, and CI/CD
+- 🎯 **Best Practices**: Industry-standard project structure with linting, testing, and analysis tools
+- 🧪 **Testing Ready**: Built-in test structure for unit, widget, and integration tests
+- 📦 **Easy Deployment**: Simple Python package that can be easily installed on any developer machine
+
+## Quick Start
+
+### Installation
+
+```bash
+# Clone the repository
+git clone <your-repo-url>
+cd flutter-setup
+
+# Install the package
+uv pip install -e .
+
+# Or install directly from GitHub (when published)
+uv pip install git+https://github.com/markcallen/flutter-setup.git
+```
+
+### Linux Prerequisites (Ubuntu/Debian)
+
+For Linux hosts, ensure APT is available and `sudo` is configured:
+
+```bash
+sudo apt-get update
+sudo apt-get install -y git curl unzip xz-utils zip libglu1-mesa clang cmake ninja-build pkg-config libgtk-3-dev libayatana-appindicator3-dev liblzma-dev openjdk-17-jdk
+```
+
+### Configuration Setup
+
+Before your first use, initialize your configuration:
+
+```bash
+# Interactive configuration setup
+flutter-setup init
+```
+
+This will:
+- Detect Flutter location from environment variables or PATH
+- Prompt for Flutter channel (stable/beta)
+- Prompt for organization ID
+- Create config file at `~/.config/flutter-setup/config.yaml`
+
+You can run `flutter-setup init` again anytime to update your configuration.
+
+### Basic Usage
+
+```bash
+# Create a new Flutter app with iOS, Android, and Web support
+flutter-setup setup MyAwesomeApp ios android web
+
+# Create a plugin with specific language preferences
+flutter-setup setup MyPlugin --template plugin --ios-language objc --android-language java ios android
+
+# Use beta channel and custom organization
+flutter-setup setup MyApp --channel beta --org com.mycompany ios android macos
+
+# Preview what would happen (dry run)
+flutter-setup setup MyApp --dry-run ios android
+```
+
+## Commands
+
+### `init` - Configuration Setup
+Initialize or update your configuration file:
+
+```bash
+flutter-setup init              # Create or update config interactively
+flutter-setup init --force      # Overwrite existing config
+```
+
+The config file is stored at `~/.config/flutter-setup/config.yaml` (or `$XDG_CONFIG_HOME/flutter-setup/config.yaml`).
+
+### `setup` - Project Setup
+Set up a new Flutter project:
+
+```bash
+flutter-setup setup MyApp ios android web
+```
+
+## Command Line Options
+
+| Option | Description | Default | Config File |
+|--------|-------------|---------|-------------|
+| `--org` | Organization identifier | `com.example` | ✅ |
+| `--channel` | Flutter channel (stable/beta) | `stable` | ✅ |
+| `--dir` | Output directory | Current directory | ❌ |
+| `--template` | Project template (app/plugin) | `app` | ✅ |
+| `--architecture` | Application architecture scaffold (basic/clean) | `basic` | ✅ |
+| `--database` | Local persistence scaffold (none/sqlite) | `none` | ✅ |
+| `--testing` | Testing starter scaffold (standard/mocktail) | `standard` | ✅ |
+| `--auth-provider` | Auth integration scaffold (none/firebase) | `none` | ✅ |
+| `--cloud-database` | Cloud database scaffold (none/firestore) | `none` | ✅ |
+| `--notifications-provider` | Push notifications scaffold (none/firebase) | `none` | ✅ |
+| `--ios-language` | iOS language for plugins (swift/objc) | `swift` | ✅ |
+| `--android-language` | Android language for plugins (kotlin/java) | `kotlin` | ✅ |
+| `--flutter-update` | Flutter update mode (reset/reclone/skip) | `reset` | ✅ |
+| `--dry-run` | Preview actions without executing | `false` | ❌ |
+| `--verbose` | Enable verbose output | `false` | ❌ |
+
+**Note:** Options marked with ✅ can be set in the config file via `flutter-setup init`. Command-line arguments override config file values.
+
+## What Gets Set Up
+
+### 1. System Prerequisites
+- ✅ macOS: Xcode Command Line Tools + Homebrew + CocoaPods
+- ✅ Linux (Ubuntu/Debian): APT-managed packages (`git`, `curl`, `unzip`, `xz-utils`, `zip`, `libglu1-mesa`, `clang`, `cmake`, `ninja-build`, `pkg-config`, `libgtk-3-dev`, `libayatana-appindicator3-dev`, `liblzma-dev`, `openjdk-17-jdk`)
+- ✅ Android development tools when Android platform is selected
+- ✅ iOS development tools only on macOS when iOS platform is selected
+
+### 2. Flutter SDK
+- ✅ Flutter SDK installation/update
+- ✅ Channel management (stable/beta)
+- ✅ PATH configuration
+- ✅ Flutter doctor validation
+
+### 3. Project Structure
+- ✅ Flutter project creation with specified platforms
+- ✅ Package name sanitization
+- ✅ Template-specific configuration
+- ✅ Optional Clean Architecture scaffold
+- ✅ Optional SQLite/Drift local persistence scaffold
+- ✅ Optional Firebase Auth, Firestore, and Firebase Messaging scaffolds
+- ✅ Optional Mocktail testing starter
+
+### 4. Development Environment
+- ✅ VS Code/Cursor configuration
+- ✅ Makefile with common commands
+- ✅ Testing framework structure
+- ✅ Code analysis and linting setup
+- ✅ GitHub Actions CI pipeline
+- ✅ Environment variable support
+- ✅ Comprehensive README
+
+## Project Structure
+
+```
+MyAwesomeApp/
+├── .vscode/                 # VS Code/Cursor configuration
+├── .github/workflows/       # CI/CD pipeline
+├── lib/                     # Flutter source code
+├── test/                    # Test files
+│   ├── unit/               # Unit tests
+│   └── widget/             # Widget tests
+├── integration_test/        # Integration tests
+├── Makefile                 # Common development commands
+├── analysis_options.yaml    # Linting and analysis rules
+├── .env                     # Environment variables
+└── README.md               # Project documentation
+```
+
+## Development Commands
+
+After setup, use these commands in your project:
+
+```bash
+# Run the app
+make run              # Chrome (default)
+make run_ios          # iOS simulator
+make run_android      # Android emulator
+
+# Testing
+make test             # Unit + widget tests
+make integration      # Integration tests
+
+# Code quality
+make analyze          # Flutter analyze
+```
+
+## Configuration
+
+The tool uses a YAML-based configuration file that stores your preferences:
+
+**Location:** `~/.config/flutter-setup/config.yaml` (or `$XDG_CONFIG_HOME/flutter-setup/config.yaml`)
+
+**Example config:**
+```yaml
+flutter:
+  location: ~/development/flutter
+  channel: stable
+  update_mode: reset
+
+project:
+  org: com.mycompany
+  template: app
+  architecture: basic
+  database: none
+  testing: standard
+  auth_provider: none
+  cloud_database: none
+  notifications_provider: none
+  ios_language: swift
+  android_language: kotlin
+```
+
+**Configuration Features:**
+- ✅ XDG Base Directory Specification compliant
+- ✅ Automatic Flutter location detection from environment
+- ✅ Interactive setup via `flutter-setup init`
+- ✅ Command-line arguments override config values
+- ✅ Persistent settings across sessions
+
+## Architecture
+
+The package is built with modern Python best practices:
+
+- **Modular Design**: Separate modules for different concerns
+- **Type Safety**: Full type hints with mypy support
+- **Error Handling**: Comprehensive exception handling
+- **Rich CLI**: Beautiful terminal output with progress indicators
+- **Configuration**: Flexible configuration system with XDG support
+- **Testing**: Built-in test structure and CI/CD
+
+## Development
+
+### Prerequisites
+
+- Python 3.12+
+- uv package manager
+
+### Supported Hosts
+
+- macOS (Darwin)
+- Linux (Ubuntu/Debian via APT)
+
+### Known Limitations
+
+- Fedora/DNF support is planned but not yet implemented.
+- iOS setup is not available on Linux hosts.
+
+### Setup Development Environment
+
+```bash
+# Clone and install
+git clone <repo-url>
+cd flutter-setup
+uv pip install -e ".[dev]"
+
+# Run tests
+uv run pytest
+
+# Format code
+uv run black .
+
+# Lint code
+uv run ruff check .
+
+# Type checking
+uv run mypy .
+```
+
+### Project Structure
+
+```
+flutter-setup/
+├── flutter_setup/           # Main package
+│   ├── __init__.py
+│   ├── cli.py              # CLI entry point
+│   ├── config.py            # Configuration management
+│   ├── core.py              # Main orchestration
+│   ├── exceptions.py        # Custom exceptions
+│   ├── prerequisites.py     # System prerequisites
+│   ├── flutter_manager.py   # Flutter SDK management
+│   ├── project_creator.py   # Project creation
+│   └── bootstrap.py         # Development environment setup
+├── pyproject.toml           # Package configuration
+├── README.md                # This file
+└── test_cli.py             # Simple test script
+```
+
+## Comparison with Bash Script
+
+This Python CLI package provides several advantages over the original bash script:
+
+| Feature | Bash Script | Python CLI |
+|---------|-------------|------------|
+| **Installation** | Manual download | `pip install` |
+| **Dependencies** | Manual management | Automatic with uv |
+| **Error Handling** | Basic | Comprehensive |
+| **Testing** | None | Full test suite |
+| **Type Safety** | None | Full mypy support |
+| **Packaging** | Manual | Standard Python package |
+| **Distribution** | Manual | PyPI ready |
+| **Maintenance** | Harder | Easier with Python tools |
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Add tests for new functionality
+5. Ensure all tests pass
+6. Submit a pull request
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+## Support
+
+For issues and questions:
+- Create an issue on GitHub
+- Check the documentation
+- Review the PRD.md for detailed requirements
+
+---
+
+**Built with ❤️ for the Flutter community**

flutter_setup-2.1.0.dist-info/RECORD

@@ -0,0 +1,20 @@
+flutter_setup/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+flutter_setup/bootstrap.py,sha256=DwGDlxH3Rq0YJ2N75z2eQA3WXyMoQ7FAyQA0pxHhNHU,29950
+flutter_setup/cicd_generator.py,sha256=hoqHrtcECrYcH-Gyrok_az-PbsHj9s7LcffKEqEgves,25924
+flutter_setup/cli.py,sha256=X6fbCci96tvQGHOADwP5wKZRJUblxIz8gqKPzyn0ezo,21792
+flutter_setup/config.py,sha256=aXIdCiXTr-u5H7ihE_m0DT-2Fe2jYkqkKcwdR1YzIeU,4729
+flutter_setup/config_manager.py,sha256=bAnuWdunLpnITDytdOrKaMAn92SfXDlKKjADO-E5YuY,5642
+flutter_setup/core.py,sha256=XrtBZZCsbOY5ONZkT8HT1k-SHDre089t1S5qjKtYh4w,7719
+flutter_setup/exceptions.py,sha256=6ZpFrshGLNjMQPqUcj_hPtyBAob0qf8_eN9LDKc0vvM,673
+flutter_setup/flutter_manager.py,sha256=LDxsQxx6MPDK9Cexv23MgTteDlAt8FI6sbmXosDALAc,21958
+flutter_setup/platform.py,sha256=Q3irgLn6dCBBSCFDo2wHqPlGdua7ha-Qda7ycBJkaPQ,394
+flutter_setup/prerequisites.py,sha256=Otr79zlZa3DXcs3c31F1liKLhecN_A_bW0Fgs958lrQ,1352
+flutter_setup/prerequisites_linux.py,sha256=XEn3WI6UrR8E4-LEKzsa3DzmidN5ST7dIkn-HCs0HrQ,4676
+flutter_setup/prerequisites_macos.py,sha256=REZaz8NAACJcKyY60CwnHDFsJe9h6R1xIS6HFdBbaw4,8561
+flutter_setup/project_creator.py,sha256=PBW1DjRelpmEpzogvoZLCd5XVPYYTDCHPNCLaZkIQ3M,2451
+flutter_setup-2.1.0.dist-info/licenses/LICENSE,sha256=dwcdo6BcRlgLd_6ejgcIIp3IUFMrCkT7fiRBMBPeulw,1068
+flutter_setup-2.1.0.dist-info/METADATA,sha256=L672avGXXOS0mzAWB6fkJgZuxUmF4PDXCHMvZPel_GU,12390
+flutter_setup-2.1.0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+flutter_setup-2.1.0.dist-info/entry_points.txt,sha256=Ff6oSyH2_elJEzbt2Es1Ftlpkqk1ogB9cX_h4NLXXrQ,57
+flutter_setup-2.1.0.dist-info/top_level.txt,sha256=BjDhT4IHIUpiQNvx9wT1LxUraEqJNpp1OlJ7F_LVI9o,14
+flutter_setup-2.1.0.dist-info/RECORD,,

flutter_setup-2.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (83.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

flutter_setup-2.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+flutter-setup = flutter_setup.cli:main

flutter_setup-2.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Mark Callen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

flutter_setup-2.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+flutter_setup