Welcome to wxpyNautilus’s documentation!

Author:

Kazuya O’moto

Generated:

Oct 05, 2023

License:

MIT

wxpyNautilus

Welcome aboard Nautilus! [1] This is a python package based on matplotlib/wxPython and wx.py.shell extension library.

The goal of our journey is the rapid development of image processing (using cv2/pillow) and the graphical user interfaces (using matplotlib/wxpython). To accomplish this, the framework consists of two main classes:

1. A plugin-style GUI mainframe

   A Plugin means a python script file to process images, which user can load, edit, reload, unload, and debug without terminating the program.

   

2. An interactive shellframe

   You can communicate with the main process using an interactive shell, inspect, test, and debug the code at runtime.

   

Getting Started

Check out github-pages for more information.

Prerequisites

This software works with Python 3.8 and later versions.

1. Download the zip file from wxpyNautilus (GitHub repository) and extract it to a suitable directory.

2. Install mwxlib from PyPI.

   >>> pip install mwxlib
   

The mwxlib depends on the following packages:

• wxPython (Phoenix) [2]

• matplotlib

• numpy

• pillow

• opencv-python

Footnotes

[1]

“Nautilus” is named after my favorite novel 海底二万里 : Twenty Thousand Leagues Under the Seas written by Jules Verne.

[2]

For Python 3.6 – 3.9, wxpython >= 4.1.1 is required. For Python 3.10, wxpython >= 4.2.0 is required. You can also download the latest snapshot from https://wxpython.org/Phoenix/snapshot-builds/.

Tutorial

Tutorial:

• 1. Shell standalone
  • 1.1. Basic access
• 2. How to inspect
  • 2.1. Autocomp
  • 2.2. Apropos
  • 2.3. Tooltip
• 3. How to debug
  • 3.1. command-hook
  • 3.2. trace-hook
  • 3.3. event-hook
• 4. How to dive
  • 4.1. Scratch
  • 4.2. Magic syntax
  • 4.3. Built-in utilities
    • 4.3.1. p(print) / pp(pprint) / filling
    • 4.3.2. where / load / mro
    • 4.3.3. dive
• 5. Mainframe
  • 5.1. Basic operation
  • 5.2. Basic access to plugins
  • 5.3. Usage of the shell
• 6. Showcase
  • 6.1. Wing of Phoenix

Feature

Feature:

• 1. Configuration
  • 1.1. ShellFrame
    • 1.1.1. Scratch
    • 1.1.2. Log
    • 1.1.3. Help
    • 1.1.4. History
    • 1.1.5. Monitor
    • 1.1.6. Inspector
    • 1.1.7. Config
  • 1.2. Mainframe
• 2. Inspection in the Shell
  • 2.1. Autocomp
  • 2.2. Apropos
  • 2.3. Tooltip
• 3. Debugger in the Shell
  • 3.1. command-hook
  • 3.2. trace-hook
  • 3.3. event-hook

Contents of package

Contents:

• wxpyNautilus package
  • Subpackages
    • wxpyNautilus.etc package
      • Submodules
      • wxpyNautilus.etc.bookshelf module
      • Module contents
    • wxpyNautilus.plugins package
      • Submodules
      • wxpyNautilus.plugins.ffmpeg_viewer module
      • wxpyNautilus.plugins.lineprofile module
      • wxpyNautilus.plugins.viewframe module
      • Module contents
  • Submodules
  • wxpyNautilus.debut module
    • atomic()
    • init_stc_interface()
    • init_buffer()
    • init_editor()
    • init_shell()
    • py_text_mode
      • py_text_mode.STYLE
    • py_interactive_mode
      • py_interactive_mode.STYLE
    • stylus()
    • MyDataLoader
      • MyDataLoader.OnData()
    • main()
  • wxpyNautilus.siteinit module
    • init_mainframe()
  • wxpyNautilus.wxNautilus module
    • MainFrame
      • MainFrame.Name
      • MainFrame.About()
  • Module contents
    • deb()

Indices and tables

• Index

• Module Index

• Search Page