Peppy Development Home

-- (ap)Proximated (x)Emacs Powered by Python

This is a wxPython/Scintilla-based editor written in and extensible through Python. It attempts to provide an XEmacs-like multi-window, multi-tabbed interface using the Advanced User Interface (wx.aui) framework of wxPython. Extensibility is based on Yapsy plugins.

This is the home of the development guide for peppy. All documentation about the architecture and inner workings of peppy in the Python language are here. If you're interested in the project management artifacts or the user guides, see the peppy homepage.

User Starting Points

• Peppy homepage -- Project summary, installation information, and project management documentation
• Downloads -- Current and past releases available for download
• User's Manual -- User's guide to peppy
  • ConfigurationFiles -- Description of the peppy configuration file

Developer Starting Points

• DevelopmentOverview -- Summary of the concepts and terms used in the source code
• ArchitectureOverview -- High level overview of the architecture of the editor
  • MenuOverview -- A description of the menu system
  • KeyboardProcessing -- Keyboard overview including keybinding specifications
  • IconResources? -- How icon resources are specified and used
• ReindentCodeLog -- A development log of how the reindent code for C-ish modes was (is) developed
• HyperspectralImagery -- Notes about the HSI major mode
• RegexSearch -- Notes on how the regular expression search was implemented
• IdeFeatures -- Notes on the development of IDE-like features like autocompletion and debugging

Tutorials

• Tutorials about adding new menu items and keyboard commands. Probably the best place to begin!
  • HelloWorldTutorial -- Walkthrough of the InsertHelloWorld action showing how to add a simple menu bar and keyboard action
  • SimpleActionTutorial -- Tutorial showing how to create a new action that works with FundamentalMode and its subclasses
• MinorModeTutorial? -- Simple example of creating a new minor mode
• SidebarTutorial? -- Adding a simple sidebar
• MajorModeTutorial? -- Adding a new major mode

Howtos

• UsingPyParse -- How to use the python parser from IDLE with a Scintilla editing component in Python

Deployment

• ApplicationBundles -- Dealing with py2exe and py2app

Reference

• Autogenerated API reference
• Major Mode reference -- for implementing a new Major Mode

• PeppyPlugins? -- Plugin overview
• Plugin API

For a complete list of local wiki pages, see TitleIndex.