CuteWindow

CuteWindow is a modern, cross-platform window library based on PySide6 that provides enhanced control and customization with native window controls and behaviors across different platforms. Create beautiful, customizable applications with ease!

✨ Features

• 🖥️ Cross-platform: Works seamlessly on Windows and macOS
• 🎨 Enhanced control: Customizable window appearance with flexible styling options
• 🎛️ Native controls: Platform-specific window buttons and behaviors
• 🎯 Customizable: Easy to customize title bar appearance and functionality
• 📱 High-DPI support: Automatic scaling for high-resolution displays
• ✨ Native animations: Smooth window animations and shadows
• 🪟 Win11 snap layout: Windows 11 snap layout support
• 🔧 Easy integration: Drop-in replacement for standard Qt windows

🚀 Quick Start

Installation

Install CuteWindow with a single command:

pip install pyside6-cutewindow

Basic Usage

Creating a customizable window is as simple as:

import sys
from PySide6.QtWidgets import QApplication
from cutewindow import CuteWindow

if __name__ == "__main__":
    app = QApplication(sys.argv)
    window = CuteWindow()
    window.setWindowTitle("My Customizable App")
    window.resize(800, 600)
    window.show()
    sys.exit(app.exec())

Window Types

CuteWindow provides three main window types for different use cases:

CuteWindow (Basic)

from cutewindow import CuteWindow

window = CuteWindow()
window.setWindowTitle("Basic Window")
window.show()

CuteMainWindow (Advanced)

from cutewindow import CuteMainWindow
from PySide6.QtWidgets import QMenuBar, QMenu, QAction

window = CuteMainWindow()
window.setWindowTitle("Main Window")

# Add menu bar
menubar = QMenuBar()
file_menu = QMenu("File", menubar)
exit_action = QAction("Exit", menubar)
file_menu.addAction(exit_action)
menubar.addMenu(file_menu)
window.setMenuBar(menubar)

window.show()

CuteDialog (Dialogs)

from cutewindow import CuteDialog
from PySide6.QtWidgets import QPushButton, QVBoxLayout, QWidget

dialog = CuteDialog()
dialog.setWindowTitle("Dialog")
dialog.setModal(True)

# Add content
layout = QVBoxLayout()
button = QPushButton("Close")
button.clicked.connect(dialog.close)
layout.addWidget(button)

container = QWidget()
container.setLayout(layout)
dialog.setCentralWidget(container)

dialog.exec()

🎨 Customization

Styling the Title Bar

from cutewindow import CuteWindow

window = CuteWindow()

# Style the title bar using CSS
window.setStyleSheet("""
    #TitleBar {
        background-color: #2b2b2b;
        border-bottom: 1px solid #3a3a3a;
    }
""")

window.show()

Custom Title Bar Widget

from PySide6.QtWidgets import QLabel, QPushButton, QHBoxLayout, QWidget
from cutewindow import CuteWindow, TitleBar

class CustomTitleBar(TitleBar):
    def __init__(self, parent=None):
        super().__init__(parent)

        # Create custom layout
        layout = QHBoxLayout(self)
        layout.setContentsMargins(10, 0, 10, 0)

        # Add title label
        title_label = QLabel("Custom Title")
        title_label.setStyleSheet("color: white; font-weight: bold;")
        layout.addWidget(title_label)

        layout.addStretch()

        # Add custom buttons
        help_btn = QPushButton("?")
        help_btn.setFixedSize(30, 20)
        layout.addWidget(help_btn)

window = CuteWindow()
window.setTitleBar(CustomTitleBar(window))
window.show()

🖼️ Screenshots

CuteWindow on macOS

CuteWindow on Windows

📋 Requirements

• Python: 3.9 or higher
• Poetry: Dependency management (recommended)
• PySide6: Qt6 bindings for Python
• Platform-specific dependencies:
  • macOS: pyobjc-framework-Cocoa, pyobjc-framework-Quartz
  • Windows: pywin32

🔧 Installation

From PyPI (Recommended)

pip install pyside6-cutewindow

From Source with Poetry (Recommended for Development)

# Clone the repository
git clone https://github.com/parhamoyan/cutewindow.git
cd cutewindow

# Install Poetry (if not already installed)
curl -sSL https://install.python-poetry.org | python3 -

# Install dependencies
poetry install

# Set up development environment
poetry install --with dev

# Set up pre-commit hooks
poetry run python scripts/setup_precommit.py

From Source with pip

git clone https://github.com/parhamoyan/cutewindow.git
cd cutewindow
pip install -e .

Development Installation with pip

git clone https://github.com/parhamoyan/cutewindow.git
cd cutewindow
pip install -e ".[dev]"
pre-commit install

📚 Documentation

Comprehensive documentation is available at https://cutewindow.readthedocs.io

• Getting Started
• Customization
• API Reference
• Examples

🎯 Examples

Check out the examples/ directory for more comprehensive examples:

• demo.py - Basic usage example
• demo_custom_title_bar.py - Custom title bar implementation
• demo_login_dialog.py - Login dialog example
• demo_title_bar_style.py - Title bar styling example

Run an example:

python examples/demo.py

🏗️ Architecture

CuteWindow uses a clean, modular architecture:

cutewindow/
├── __init__.py                 # Main package interface
├── base.py                     # Abstract base classes
├── Icon.py                     # Enhanced icon handling
├── platforms/                  # Platform-specific implementations
│   ├── __init__.py            # Platform detection
│   ├── mac/                   # macOS implementation
│   │   ├── CuteWindow.py
│   │   ├── CuteMainWindow.py
│   │   ├── CuteDialog.py
│   │   ├── TitleBar.py
│   │   └── utils.py
│   └── windows/               # Windows implementation
│       ├── CuteWindow.py
│       ├── CuteMainWindow.py
│       ├── CuteDialog.py
│       ├── TitleBar.py
│       ├── utils.py
│       ├── native_event.py
│       └── c_structures.py
└── examples/                   # Usage examples

Platform-Specific Features

Windows

• Native window shadows via DWM
• Windows 11 snap layout support
• Smooth window animations
• Native window buttons
• Aero Snap functionality

macOS

• Native traffic lights (red, yellow, green buttons)
• Smooth window animations
• Full-screen support
• Native window shadows
• Mission Control integration

🔄 CI/CD

CuteWindow uses GitHub Actions for continuous integration and deployment:

• CI Pipeline: Runs on every push and pull request to ensure code quality

  • Tests across multiple Python versions (3.8-3.12) and platforms (Windows, macOS)
  • Code formatting checks (Black, isort)
  • Linting (flake8)
  • Type checking (mypy)
  • Security scanning (safety, bandit)
  • Package building and installation testing

• Documentation: Automatically builds and deploys documentation to Read the Docs

• Code Quality: Comprehensive quality checks and security scanning

• Automated Publishing: Publishes to PyPI when new tags are created

Quality Checks

The CI pipeline enforces the following quality standards:

• Code Style: Black formatting and isort import sorting
• Type Safety: Mypy static type checking
• Code Quality: Flake8 linting with strict rules
• Security: Dependency and code security scanning
• Code Quality: Comprehensive quality checks and security scanning

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

Development Setup

1. Fork the repository
2. Clone your fork: git clone https://github.com/your-username/cutewindow.git
3. Navigate to the project: cd cutewindow
4. Install dependencies with Poetry: poetry install --with dev
5. Set up pre-commit hooks: poetry run python scripts/setup_precommit.py
6. Create your feature branch: git checkout -b feature/amazing-feature
7. Make your changes and ensure they pass quality checks: poetry run python scripts/quality_check.py
8. Run quality checks: poetry run python scripts/quality_check.py
9. Format your code: poetry run python scripts/format_code.py or poetry run black . && poetry run isort .
10. Commit your changes: git commit -m 'feat: add amazing feature'
11. Push to the branch: git push origin feature/amazing-feature
12. Open a Pull Request

Code Style

We use:

• Black for code formatting
• isort for import sorting
• flake8 for linting
• mypy for type checking
• bandit for security scanning
• safety for dependency safety

Development Tools

The project includes several convenience scripts:

# Run comprehensive quality checks
poetry run python scripts/quality_check.py

# Run quality checks
poetry run python scripts/quality_check.py

# Auto-format code
poetry run python scripts/format_code.py

# Set up pre-commit hooks
poetry run python scripts/setup_precommit.py

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

📞 Support

• 📧 Email: [email protected]
• 🐛 Issues: GitHub Issues
• 💬 Discussions: GitHub Discussions
• 📖 Documentation: Read the Docs

🗺️ Roadmap

• Additional window customization options
• More examples and tutorials
• PyQt6 support

---

Made with ❤️ by Parham Oyan