Welcome to Odoo Helper - PyCharm – Version 1.6.1
This guide offers complete documentation for the Cybrosys Assista plugin, an advanced Odoo development assistant for PyCharm. Whether you're scaffolding your first module or managing large-scale enterprise applications, Assista streamlines your development workflow with intelligent automation, context-aware suggestions, and comprehensive code quality tools.
Overview
The Cybrosys Assista plugin transforms PyCharm into a powerful Odoo development environment by providing intelligent assistance at every stage of module development. From initial project setup to code maintenance, the plugin offers a suite of tools designed to accelerate development while maintaining high code quality standards.
Key Features
Core Development Tools
- Module Template Generator: Instantly scaffold Odoo modules with standard structures, models, views, security, and more.
- Odoo File Creator: Quickly generate Python, XML, and CSV files with pre-filled content based on best practices.
- Code Snippet Assistant: Access reusable code blocks with simple keywords for faster and more consistent development.
Intelligent Assistance
- Smart Suggestions: Leverage intelligent auto-completion for fields, models, views, decorators, and attributes—both in Python and XML.
- Template Suggestions: Provides template name suggestions inside
<t t-call>tags for enhanced QWeb development. - Manifest Dependency Suggestions: Auto-completes module names in the depends field of
__manifest__.pyfor accurate dependency management. - Field Suggestions in self.mapped: Suggests available field names based on the current recordset for improved data manipulation.
Quality Assurance
- Standard Inspections: Automatically detect and highlight violations of Odoo coding conventions with 70+ validation rules.
- Real-time Validation: Inline error highlighting with precise location reporting and automated quick fixes.
Automation Features
- Auto Path Insertion: Automatically updates
__init__.pyand__manifest__.pywhen creating new models or views—removing manual steps and reducing mistakes. - Context-Aware File Creation: Ensures that files are only created in appropriate locations within an Odoo module structure.
Context-Aware Restrictions
- Module Template Validation: Module templates can only be created inside valid directories to maintain proper project structure.
- Component-Specific Creation: Restricts Python file creation to appropriate components like models, and view file creation to view directories.
- Location Validation: Prevents creation of files in inappropriate locations, maintaining clean project organization.
Active Development and Community
- Continuous Updates: Regular releases with new features, bug fixes, and performance improvements.
- Community Contributions: Open to community feedback, feature requests, and code contributions.
- Version Compatibility: Ongoing support for new PyCharm and Odoo versions.
- Responsive Development: Quick response to community needs and emerging Odoo development trends.
Development Comparison: Traditional vs. Assista-Enhanced
Development Efficiency
| Aspect | Traditional Development | Assista-Enhanced Development |
|---|---|---|
| Module Setup Time | 15-30 minutes for basic module | 30 seconds to 2 minutes |
| Code Entry | Manual typing of every field and method | Smart completions and snippets |
| File Management | Manual updates to __init__.py and __manifest__.py | Auto path insertion |
| Error Detection | Issues found during testing | Real-time validation and feedback |
| Code Review | Extensive manual review required | Pre-validated code |
Code Quality and Standards
| Aspect | Traditional Development | Assista-Enhanced Development |
|---|---|---|
| Standards Compliance | Varying adherence to conventions | Enforced coding standards |
| Code Consistency | Inconsistent styles across team | Standardized templates and patterns |
| Validation | No automated Odoo checks | 70+ validation rules |
| Documentation | Manual documentation overhead | Auto-generated documentation |
| Best Practices | Time spent discovering patterns | Templates follow established conventions |
Team Productivity
| Aspect | Traditional Development | Assista-Enhanced Development |
|---|---|---|
| Learning Curve | Steep, trial-and-error approach | Guided learning with templates |
| Onboarding | Extensive training required | Quick start with guided templates |
| Knowledge Sharing | Individual approaches create silos | Shared snippets and templates |
| Maintenance | Inconsistent codebase harder to maintain | Consistent structure simplifies maintenance |
| Version Control | Complex merge conflicts | Clean, structured changes |
Benefits for Developers
Time Savings
- Rapid Module Creation: Generate complete module structures in seconds instead of minutes
- Automated Boilerplate: Eliminate repetitive code writing with intelligent templates
- Smart Completions: Reduce typing with context-aware suggestions that understand Odoo patterns
- Auto-imports: Automatic path insertion saves time on manual file updates
Code Quality Enhancement
- Consistent Standards: Enforce Odoo coding conventions automatically
- Error Prevention: Real-time validation catches issues before they become problems
- Best Practice Enforcement: Templates and snippets follow established Odoo patterns
- Cross-reference Validation: Ensure model and field references are accurate
Learning and Onboarding
- Template Learning: Study generated code to understand Odoo patterns
- Snippet Reference: Comprehensive library of common Odoo code patterns
- Contextual Help: Intelligent suggestions teach proper Odoo development practices
- Error Guidance: Detailed explanations of validation failures help developers learn
Team Collaboration
- Consistent Codebase: Standardized templates ensure team-wide consistency
- Reduced Review Time: Pre-validated code reduces code review overhead
- Shared Patterns: Common snippets and templates create team standards
- Documentation Integration: Generated code includes proper documentation
Enterprise Development
- Scalable Workflows: Handle large projects with consistent tooling
- Quality Gates: Automated validation ensures production-ready code
- Maintenance Efficiency: Well-structured code is easier to maintain and extend
- Performance Optimization: Proper field definitions and model structures
Development Workflow Integration
Project Initialization
- Quick Start: Generate new modules with proper structure and dependencies
- Template Selection: Choose from basic, advanced, OWL, theme, or systray modules
- Dependency Management: Automatic manifest updates with proper module references
- Security Setup: Pre-configured access rights and security groups
Daily Development
- File Creation: Generate models, views, controllers with proper structure
- Code Completion: Intelligent suggestions for fields, methods, and attributes
- Validation: Real-time feedback on code quality and standards compliance
- Snippet Access: Quick insertion of common Odoo patterns
Code Maintenance
- Refactoring Support: Context-aware suggestions during code modifications
- Quality Checks: Continuous validation of code changes
- Documentation: Auto-generated docstrings and comments
- Testing Support: Proper test structure and mock data generation
Technical Capabilities
Advanced Code Analysis
- 70+ Validation Rules: Comprehensive coverage of Odoo development standards
- Cross-file Validation: Ensures consistency across Python, XML, and CSV files
- Context Awareness: Suggestions adapt to current file type and location
- Performance Optimization: Efficient indexing and suggestion algorithms
Template System
- 6 Module Types: Basic, Advanced, OWL Basic, OWL Advanced, Theme, Systray
- File Templates: Python, XML, CSV with proper Odoo structure
- Customizable: Templates follow Odoo best practices but remain editable
- Version Compatibility: Templates adapt to different Odoo versions
Integration Features
- PyCharm Native: Seamless integration with existing PyCharm features
- Keyboard Shortcuts: Quick access to common functions
- Context Menus: Right-click access to Odoo-specific actions
- Project Awareness: Understands Odoo project structure and conventions
Quick Links
Stability and Performance
Version 1.4.0 includes comprehensive improvements focused on stability, performance optimization, and enhanced user experience. The plugin maintains compatibility with PyCharm Professional and Community editions while providing enterprise-grade development tools.
Performance Enhancements
- Optimized Indexing: Faster project analysis and suggestion generation
- Memory Efficiency: Reduced resource usage for large projects
- Caching Improvements: Better performance for repeated operations
- Background Processing: Non-blocking validation and analysis
Stability Improvements
- Error Handling: Robust error recovery and graceful degradation
- Compatibility: Enhanced support for different PyCharm versions
- Reliability: Reduced crashes and improved error reporting
- Maintenance: Easier updates and configuration management
Cybrosys Assista is built to enhance your development speed, code quality, and productivity—right inside PyCharm.
Trusted by thousands of Odoo developers worldwide.
Need assistance or have feedback? Reach out via our Support page or connect with our developer community.
This documentation is created and maintained by Cybrosys Assista - PyCharm Plugin Development Team.