kaa - console text editor.
Project description
Kaa is a small and easy text editor for console environment.
Overview
Kaa is a easy yet powerful text editor for console user interface providing numerous features like
Macro recording.
Undo/Redo.
Multiple windows/frames.
Syntax highlighting.
Open source software(MIT)
More to come!
Kaa is easy!
Kaa is very easy to learn in spite of its rich functions. Only thing you need to remember is “To display menu, hit F1 key or alt+’/’ key”. Most of basic feartures could be accessed from fancy menus by hitting underlined character in the menu items. You can use Kaa as easy as you are with Notepad on MS-Windows.
Customisable
Kaa is written in Python. So, you can easily customise many aspects of kaa with simple Python scripts.
Requirements
Python 3.3 or later
Headers and libraries for ncurses with wide character support. Consult documentation of your platform for details. For Debian/Ubuntu, you can install ncurses library by
$ sudo apt-get install libncurses5 libncurses5-dev libncursesw5 libncursesw5-dev
UTF-8 locales
(optional) Cython
Installation
Use easy_install3 or pip3 to install kaa from PyPI
$ easy_install3 kaaedit
Command line options
To start kaa, type
$ kaa [-h] [--version] [FILE [FILE ...]] optional arguments: -h, --help show this help message and exit --version show version info and exit
Usage
Using kaa is intuitive. Typing alphabet keys will update file as you expected. Functional keys like arrow or delete keys also works.
Key bindings
Input mode
- F1, alt+/
Show menu.
- Arrow keys(up, down, left, right)
Move cursor.
- Shift+arrow keys
Select text.
- Control+left/right arrow keys
Move cursor to next/prev word boundary.
- Control+b, Control+f, Control+p, Control+n
Move cursor to left/right/up/down.
- Alt+b, Alt+f
Move cursor to next/prev word boundary.
- Control+v, Alt+v
Page down/up
- Home, Shift+Home
Move cursor to top of line. Shift+Home selects text to top of line.
- End, Shift+End
Move cursor to end of line. Shift+Home selects text to end of line.
- Control+Home, Control+Shift+Home
Move cursor to top of file. Control+Shift+Home selects text to top of file.
- Control+End, Control+Shift+End
Move cursor to end of file. Control+Shift+End selects text to end of file.
- Control+g
Go to line number.
- Alt+a
Select all text.
- Ctrl+c
Select current word for first press, current line for second time and entire text for third time.
- Backspace, Control+h
Delete the character to the left.
- Delete, Control+d
Delete the character at the cursor.
- Control+backspace, Alt+h
Delete the word to the left.
- Control+Delete, Alt+d
Delete the word to the right.
- Control+k
Delete the line to the right.
- Alt+k
Delete the current line.
- Control+y
Paste
- Control+w
Cut selection
- Alt+w
Copy selection
- Control+u
Undo last change.
- Alt+u
Redo last undo.
- F6
Toggle macro recording on/off.
- F5
Run macro.
- Alt+.
Run last execused edit command again.
- Control+s
Search text.
- Alt+s
Replace text.
- Tab, Shift+Tab
Indent/dedent selection
- Alt-M v
Show text conversion menu.
- Ctrl+u Alt+!
Execute command and insert the output.
Customization
Kaa executes a Python script file at ~/.kaa/__kaa__.py on startup. You can write Python script to customize Kaa as you like.
Sample - Show line numbers
from kaa.filetype.default import defaultmode
defaultmode.DefaultMode.SHOW_LINENO = Truedefaultmode.DefaultMode is base class of all text file types. Line number is diplayed if Defaultmode.SHOW_LINENO is True. If you want to show line number of paticular file types, you can update SHOW_LINENO attribute of each file type classes.
# Show line number in HTML mode
from kaa.filetype.html import htmlmode
htmlmode.HTMLMode.SHOW_LINENO = TrueSample - Customize key binding
Assign same keyboard shortcut of splitting windows command as Emacs.
from kaa.keyboard import *
from kaa.filetype.default.defaultmode import DefaultMode
DefaultMode.KEY_BINDS.append({
((ctrl, 'x'), '2'): 'editor.splithorz' # Assign C-x 2
})In this example, key sequence C-x 2 (control+x followed by 2) is assigned to ‘editor.splithorz’ command.
Version history
0.0.3 - 2013.10.9
Incremental search.
Accept directory name as command line argument.
New command: Go to line(^g).
New command: Select current word(^c).
New command: Save all files(menu|file|Save All).
Improve file open dialog.
0.0.2 - 2013.10.5
Misc commands.
Highlight parenthesis at cursor.
Support text encodnig other than utf-8.
Other a lot of changes.
0.0.1 - 2013.6.16
Initial release.
Copyright
Copyright (c) 2013 Atsuo Ishimoto
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
