Index of All Documentation


Wing Pro Quick Start Guide

Wing Pro Tutorial

1. Tutorial: Why Wing?
2. Tutorial: Getting Started
3. Tutorial: Getting Around Wing
4. Tutorial: Check your Python Integration
5. Tutorial: Set Up a Project
6. Tutorial: Setting Python Path
7. Tutorial: Introduction to the Editor
8. Tutorial: Navigating Code
9. Tutorial: Debugging
   9.0. Tutorial: Debug I/O
   9.1. Tutorial: Debug Process Exception Reporting
   9.2. Tutorial: Interactive Debugging
   9.3. Tutorial: Execution Environment
   9.4. Tutorial: Debugging from the Python Shell
   9.5. Tutorial: Debugging Code Not Launched by the IDE
   9.6. Tutorial: Other Debugger Features
10. Tutorial: Auto-Editing
11. Tutorial: Turbo Completion Mode
12. Tutorial: Code Warnings
13. Tutorial: Refactoring
14. Tutorial: Indentation Features
15. Tutorial: Other Editor Features
16. Tutorial: Unit Testing
17. Tutorial: Version Control Systems
18. Tutorial: Searching
   18.0. Tutorial: Toolbar Search
   18.1. Tutorial: Keyboard-Driven Search and Replace
   18.2. Tutorial: Search Tool
   18.3. Tutorial: Search in Files
19. Tutorial: Other IDE Features
20. Tutorial: Further Reading

How-Tos

1. How-Tos for Containers
   1.0. Using Wing with virtualenv
   1.1. Using Wing with Anaconda
   1.2. Using Wing with Docker
   1.3. Using Wing with Vagrant
   1.4. Using Wing Pro with Windows Subsystem for Linux
   1.5. Using Wing with Cygwin
   1.6. Remote Python Development
2. How-Tos for Scientific and Engineering Tools
   2.0. Using Wing with matplotlib
   2.1. Using Wing with Jupyter Notebooks
3. How-Tos for Web Development
   3.0. Remote Web Development
   3.1. Using Wing with Django
   3.2. Using Wing with Flask
   3.3. Using Wing with Pyramid
   3.4. Using Wing with web2py
   3.5. Using Wing with mod_wsgi
4. How-Tos for GUI Development
   4.0. Using Wing with wxPython
   4.1. Using Wing with PyQt
   4.2. Using Wing with GTK and PyGObject
5. How-Tos for Modeling, Rendering, and Compositing Systems
   5.0. Using Wing with Blender
   5.1. Using Wing with Autodesk Maya
   5.2. Using Wing with NUKE and NUKEX
   5.3. Using Wing with Source Filmmaker
6. How-Tos for Educational Tools
   6.0. Using Wing with Raspberry Pi
   6.1. Using Wing with pygame
7. Unmaintained How-Tos
   7.0. Using Wing with Twisted
   7.1. Using Wing with Plone
   7.2. Using Wing with Turbogears
   7.3. Using Wing with Zope
   7.4. Using Wing with Google App Engine SDK for Python
   7.5. Using Wing with mod_python
   7.6. Debugging Code Running Under Py2exe
   7.7. Using Wing with IDA Python
   7.8. Using Wing with IronPython

Wing Pro Reference Manual

1. Introduction
   1.0. Product Levels
   1.1. Licenses
   1.2. Supported Platforms
   1.3. Supported Python versions
   1.4. Technical Support
   1.5. Prerequisites for Installation
   1.6. Installing Wing
   1.7. Running Wing
   1.8. Installing Your License
   1.9. Settings Directory
   1.10. Upgrading
      1.10.0. Migrating From Older Versions
      1.10.1. Fixing a Failed Upgrade
   1.11. Installation Details and Options
      1.11.0. Linux Installation Notes
      1.11.1. Remote Display on Linux
      1.11.2. Source Code Installation
   1.12. Backing Up and Sharing Settings
   1.13. Removing Wing
   1.14. Command Line Usage
2. Customization
   2.0. High Level Configuration Options
   2.1. User Interface Options
      2.1.0. Display Style and Colors
      2.1.1. Windowing Policies
      2.1.2. User Interface Layout
      2.1.3. Text Font and Size
   2.2. Keyboard Personalities
      2.2.0. Key Bindings
      2.2.1. Key Maps
      2.2.2. Key Names
   2.3. Preferences
      2.3.0. Preferences File Layers
      2.3.1. Preferences File Format
   2.4. Custom Syntax Coloring
   2.5. Perspectives
   2.6. File Filters
3. Project Manager
   3.0. Creating a Project
   3.1. Moving Projects
   3.2. Display Options
   3.3. Opening Files
   3.4. File Operations
   3.5. Creating, Renaming, and Deleting Files
   3.6. Project Properties
      3.6.0. Environment Variable Expansion
   3.7. File Properties
   3.8. Sharing Projects
   3.9. Launch Configurations
4. Source Code Editor
   4.0. Opening, Creating, and Closing Files
   4.1. File Status and Read-Only Files
   4.2. Transient, Sticky, and Locked Editors
   4.3. Editor Context Menu
   4.4. Navigating Source
   4.5. Source Assistant
   4.6. Folding
   4.7. Bookmarks
   4.8. Syntax Coloring
   4.9. Selecting Text
      4.9.0. Multiple Selections
   4.10. Copy/Paste
   4.11. Auto-completion
      4.11.0. Turbo Completion Mode for Python
      4.11.1. Auto-completion Icons
      4.11.2. How Auto-completion Works
   4.12. PEP 8 Reformatting
   4.13. Auto-Editing
   4.14. Code Snippets
      4.14.0. Snippet Syntax
      4.14.1. Snippets Directory Layout
   4.15. Indentation
      4.15.0. How Indent Style is Determined
      4.15.1. Indent Guides, Policies, and Warnings
      4.15.2. Auto-Indent
      4.15.3. The Tab Key
      4.15.4. Adjusting Indentation
      4.15.5. Indentation Tool
   4.16. Keyboard Macros
   4.17. Auto-Reloading Changed Files
   4.18. Auto-Save
   4.19. File Sets
   4.20. Other Editor Features
5. Search and Replace
   5.0. Toolbar Quick Search
   5.1. Keyboard-Driven Search and Replace
   5.2. Search Tool
   5.3. Search in Files Tool
   5.4. Find Points of Use
   5.5. Wildcard Search Syntax
6. Code Warnings and Quality Inspection
   6.0. Code Warnings Tool
   6.1. Warnings on the Editor
   6.2. Warnings Types
   6.3. Advanced Configuration
   6.4. External Code Quality Checkers
7. Refactoring
   7.0. Rename Symbol
   7.1. Move Symbol
   7.2. Extract Function / Method
   7.3. Introduce Variable
   7.4. Symbol to *
8. Difference and Merge
9. Source Code Browser
   9.0. Display Choices
   9.1. Symbol Types
   9.2. Display Filters
   9.3. Sorting the Display
   9.4. Navigating the Views
10. Integrated Python Shell
   10.0. Python Shell Environment
   10.1. Active Ranges in the Python Shell
   10.2. Debugging Code in the Python Shell
   10.3. Python Shell Options
11. OS Commands Tool
   11.0. OS Command Properties
   11.1. Sharing Projects with OS Commands
12. Unit Testing
   12.0. Project Test Files
   12.1. Running and Debugging Tests
   12.2. Running unittest Tests from the Command Line
13. Debugger
   13.0. Debugger Quick Start
   13.1. Debug Environment
   13.2. Named Entry Points
   13.3. Specifying Main Entry Point
   13.4. Setting Breakpoints
   13.5. Starting Debug
   13.6. Debugger Status
   13.7. Flow Control
   13.8. Viewing the Stack
   13.9. Viewing Debug Data
      13.9.0. Stack Data Tool
         13.9.0.0. Array, Data Frame, and Textual Data Views
         13.9.0.1. Stack Data Options Menu
         13.9.0.2. Stack Data Context Menu
         13.9.0.3. Filtering Value Display
         13.9.0.4. Advanced Data Display
      13.9.1. Viewing Data on the Editor
      13.9.2. Watching Values
      13.9.3. Evaluating Expressions
      13.9.4. Problems Handling Values
   13.10. Debug Process I/O
      13.10.0. External I/O Consoles
      13.10.1. Debug Process I/O Multiplexing
   13.11. Interactive Debug Console
      13.11.0. Managing Program State
      13.11.1. Debugging Code Recursively
      13.11.2. Debug Console Options
      13.11.3. Debug Console Limitations
   13.12. Multi-Process Debugging
      13.12.0. Debugging Child Processes
      13.12.1. Process Control
   13.13. Debugging Multi-threaded Code
   13.14. Managing Exceptions
   13.15. Running Without Debug
14. Advanced Debugging Topics
   14.0. Debugging Externally Launched Code
      14.0.0. Debugging Externally Launched Remote Code
      14.0.1. Externally Launched Process Behavior
      14.0.2. Debugging Embedded Python Code
      14.0.3. Configuring wingdbstub
      14.0.4. Debugger API
   14.1. Manually Configured Remote Debugging
      14.1.0. Manually Configuring SSH Tunneling
      14.1.1. Manually Configured File Location Maps
         14.1.1.0. Manually Configured File Location Map Examples
      14.1.2. Manually Configured Remote Debugging Example
      14.1.3. Manually Installing the Debugger
   14.2. Using wingdb to Initiate Debug
   14.3. Attaching and Detaching
   14.4. Debugging C/C++ and Python Together
      14.4.0. Debugging Extension Modules on Linux/Unix
   14.5. Debugging Non-Python Mainloops
   14.6. Debugging Code with XGrab* Calls
   14.7. Debugger Limitations
15. Integrated Version Control
   15.0. Setting Up Version Control in Wing
   15.1. Version Control Tools
   15.2. Common Version Control Operations
   15.3. Bazaar
   15.4. CVS
   15.5. Git
   15.6. Mercurial
   15.7. Perforce
   15.8. Subversion
16. Source Code Analysis
   16.0. How Analysis Works
   16.1. Helping Wing Analyze Code
      16.1.0. Setting the Correct Python Environment
      16.1.1. Using Live Runtime State
      16.1.2. Adding Type Hints
      16.1.3. Defining Interface Files
   16.2. Analysis Disk Cache
17. Remote Development
   17.0. Setting up SSH for Remote Development
   17.1. Configuring Remote Hosts
   17.2. Setting up Remote Projects
   17.3. Remote Development Features
   17.4. Remote Agent User Settings
   17.5. Specifying Environment for the Remote Python
   17.6. Manually Installing the Remote Agent
   17.7. SSH Setup Details
      17.7.0. Working With OpenSSH
      17.7.1. Working With PuTTY
      17.7.2. Enabling Windows 10 OpenSSH Client
18. Scripting and Extending Wing
   18.0. Scripting Example Tutorial
   18.1. Overview of the Scripting Framework
   18.2. Scripting API
   18.3. Script Syntax
      18.3.0. Script Attributes
      18.3.1. Adding Scripts to the GUI
      18.3.2. Argument Collection
      18.3.3. Importing Other Modules
      18.3.4. Internationalization and Localization
      18.3.5. Plugins
   18.4. Debugging Extension Scripts
   18.5. Advanced Scripting
   18.6. API Reference
      18.6.0. API Reference - Utilities
      18.6.1. API Reference - Application
      18.6.2. API Reference - Editor
      18.6.3. API Reference - Project
      18.6.4. API Reference - Debugger
      18.6.5. API Reference - Search
      18.6.6. API Reference - Analysis
19. Trouble-shooting Guide
   19.0. Trouble-shooting Failure to Start
   19.1. Speeding up Wing
   19.2. Trouble-shooting Failure to Debug
      19.2.0. Failure to Start Debug
      19.2.1. Failure to Stop on Breakpoints or Show Source Code
      19.2.2. Failure to Stop on Exceptions
      19.2.3. Extra Debugger Exceptions
   19.3. Trouble-shooting Other Known Problems
   19.4. Obtaining Diagnostic Output
20. Preferences Reference
21. Command Reference
   21.0. Top-level Commands
   21.1. Project Manager Commands
   21.2. Editor Commands
   21.3. Search Manager Commands
   21.4. Unit Testing Commands
   21.5. Version Control Commands
   21.6. Debugger Commands
   21.7. Script-provided Add-on Commands
22. Key Binding Reference
   22.0. Wing Personality
   22.1. Emacs Personality
   22.2. VI/VIM Personality
   22.3. Visual Studio Personality
   22.4. OS X Personality
   22.5. Eclipse Personality
   22.6. Brief Personality
23. License Information
   23.0. Wing Pro Software License
   23.1. Open Source License Information
   23.2. Privacy Policy