Optics Framework¶
Welcome to the official documentation for the Optics Framework, an open-source test automation framework designed to simplify and streamline the creation and execution of automated tests across various platforms. Whether you're testing mobile apps (including DRM-enabled ones), Optics Framework provides a flexible, extensible, and user-friendly solution to meet your testing needs.
Key Features¶
-
Vision Powered
UI object detections powered by computer vision, not just XPath elements
-
No Code Automation
Build automation scripts without programming knowledge or IDE access
-
Non-Intrusive Drivers
Support for BLE mouse and keyboard for production monitoring
-
Data-Driven Testing
Execute test cases dynamically with multiple datasets
-
Extensible & Scalable
Easily add new keywords and modules without hassle
-
AI Integration
Choose which AI models to use for object recognition and OCR
-
Self-Healing
Automatic fallback to alternative detection methods when primary fails
Quick Start¶
Get started with Optics Framework in minutes:
pip install optics-framework
optics setup --install Appium EasyOCR
optics init --name my_test_project --path . --template contact
optics execute my_test_project
Explore Documentation¶
-
Introduction
Learn about the framework's architecture and capabilities
-
Quick Start
Get up and running with your first test in minutes
-
Architecture
Deep dive into the framework's architecture, components, and design patterns
-
User Workflow
Understand the typical workflow for creating and running tests
-
Usage
Comprehensive guides for CLI and keyword usage
-
API Reference
Python API documentation and REST API usage guides
-
Developer Guide
Learn how to extend and contribute to the framework
-
Contributing
Guidelines for contributing to the project
-
Help Wanted
Areas where we need your help to improve the framework
-
Code of Conduct
Our community standards and expectations
Need Help?¶
- GitHub Issues - Report bugs or request features
- Documentation - Browse the full documentation
- Contact - Reach out for support