Metadata-Version: 2.4
Name: pyedpro
Version: 3.8.0
Summary: High power editor in python.
Home-page: https://github.com/pglen/pyedpro
Author: Peter Glen
Author-email: peterglen99@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: LICENSE.backup
Requires-Dist: pyvpacker
Requires-Dist: pydbase
Requires-Dist: pyvguicom
Requires-Dist: pygobject==3.50.1
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

#   PyEdPro README

## Python editor.

   Welcome to PyEdPro. This is modern multi-platform editor. Simple,
    powerful, configurable, extendable. Goodies like macro recording /
    playback, spell check, column select, multiple clipboards, unlimited
    undo ... makes it an editor that I use every day.

  Working and tested platforms currently are:

        Win 7 .. Win 10 ...
        Centos 6 .. 7 Ubuntu 14 ... 16 ...  20.x (should run on any linux )
        Windows (Native) plus MSYS2, Mingw,
        Raspberry PI 3, Raspberry PI 4, ...
        Mac ** Some functions are disabled - in particular async processing

Pyedpro functions in a near identical manner ...
    on Linux / Windows / Mac / Raspberry PI

 Pyedpro has:

            o  Macro recording/play,
            o  Search/replace,
            o  Functional navigation,
            o  Fomment/string spell check,
            o  Full spell check, spell suggestion dialog
            o  Auto backup,
            o  Persistent undo/redo,  (undo beyond last save, no limits)
            o  Auto complete, auto correct
            o  Last version backup into .pyedpro/data/ 10 deep
            o  AutoSave backup into .pyedpro/data/ 10 deep
            o
            o  ... and a lot more.

 It is fast, it is extendable. The editor has a table driven key mapping.
 One can easily edit the key map in keyhand.py, and the key actions
 in acthand.py The default key map resembles gedit / wed / etp / brief

 The editor can be run from pip; from single packed executable; from git
directory, and from packaged appimage.

### Quick install, quick start:

    pip install pyedpro

 The images are available from the git largefile subsystem and on release.

[See Doxygen generated Documentation on GitHub Pages](https://pglen.github.io/pyedpro/html/)

Newer Linux(es) changed the pip subsystem for higher security. One can use pipx
    with the injection feature.

###  Debian 13

    sudo apt install -y python3-dev pkg-config libgirepository1.0-dev \
    libcairo2-dev gir1.2-gtk-3.0    # if needed

    pipx install pyedpro
    pipx inject pyedpro pygobject
    pipx inject pyedpro requests

    On later versions of pygobject the slider stopped working. As it
    is a virtual environment, you are free to use an older pygobject like
    version '3.42.1' -> pygobject==3.42.1

###  Ubuntu 22.x +
    # Assuming dependencies are OK
    pip install pyedpro
    --- or ---
    pipx install pyedpro
    pipx inject pyedpro pygobject==3.42.1

###  Ubuntu 24.x +

    sudo apt install pipx  # If needed
    pipx install pyedpro
    pipx inject pyedpro pygobject==3.42.1
    pipx inject pyedpro requests

###  Fedora (tested on 42)

    pip install pyedpro

### Platforms

  I mainly run it on Ubuntu 22.x, and in Win32 / MSYS2, some Fedora, Windows 10,
(x64) and the Raspberry-Pi. It behaves consistently on all these platforms,
it is an absolute joy to edit in a different platform without the learning
curve of new keystrokes.  If you want an editor that works the same way in
all your workspaces, PyEdPro is the one.

 PyEdPro now is working OK on the Mac M1. I installed homebrew, and got
it to fire up. It was not a trivial exercise, as the Mac PygGOject did not do
half of the stuff as the Linux version did.
No asynchronous  anything, segmentation faults everywhere. (which python
is not suppose to have)

  The font rendering was messed up, but I got fixed by replacing Pango's
get_pixel_size() with get_size() / PANGO_UNIT. [Suspect int vs float
accuracy issues]  Some async functions like the function updater is
disabled, but it can be done manually. (right click on doc -> rescan)
All in all the Mac's PyGobject is not a great subsystem, hopefully time
will be kind here.

** tried the M1 ... Sun 03.Apr.2022 most of it worked; no async processing
as in : Glib.timer functions bombed. Great hardware - bad PyGobject
support. However if an editor with familiar key op is needed -- most of
it works. And no destructive errors.

### History:

    (this is extracted, use git log for up-to-date information)
    3.7.9   Tue 02.Dec.2025 -- Corrected pydlg modal keyword
    3.7.5   Sat 15.Nov.2025 -- Tested pipx on newer linux (es)
    3.7.4   Sat 25.Oct.2025 -- Updated left side function displays
    3.7.3   Mon 20.Oct.2025 -- lookup for function names now line number based
    3.3.1   Fri 15.Mar.2024 -- corrected for changes in the public pydbase interface
    3.3.5   Wed 10.Apr.2024 -- Relocated search window for better screen allocation
    3.3.8   Sun 05.May.2024 -- WebView update, pipx installation ...
    Mon 15.Sep.2025 -- Corrected sigterm behavior, now remembers session correctly
    Mon 30.Sep.2024 -- Right click menu simplified, Ver 3.4.0
    Sat 11.Feb.2023 -- Pyedpro Notes export / import and the new pydbase data base
    Thu 27.Oct.2022 -- Restored system menu processing (Alt-f [File Menu] and such)
    Sat 10.Sep.2022 -- the system shortcuts (ctrl-s ctrl-o) are re-done by hand
    Sat 03.Sep.2022 -- published on pip
    Thu 21.Apr.2022 -- release issued
    Wed 16.Mar.2022 -- dialog for read only file, export notes ... lots of other stuff
    Wed 01.Dec.2021 -- on search, descending one dir level with Ext. Search
    Sun 05.Sep.2021 -- made it function on the Mac M1 laptop  - !@#$$%
        ....        -- lot of changes, see github log

Partial list, some highlights;

Added separate interpretation for right control keys, so exotic items
like 'insert html comment' can be tied to a shortcut key;

Added drag / drop source / target. New keystroke combo for keyboards
  without home / pgup etc ...
Implemented html preview. Just right click on the file body, an select
  the corresponding menu item.
Implemented markdown preview. Right click ... menu
Implemented M4 preview. The files are pulled in from the current directory (of the macro),
  and expanded with the m4 macro processor. The results than are previewed
  in an html window. (Yes, head and footer are now one file for the whole site,
  the way it should be) Right click ... and look for: Filter to M4

Added drag and drop. Accepts file name from file manager, and accepts clipboard text.
The dropped content is inserted where the editor's caret is. (not where the cursor is)
The caret is moved to the end of insertion.

 This (above / below) list is an extract, please see git log for complete history.

  PyEdPro now has buffer diff. Right clicking on the file's tab header presents a menu.
One may select the diff source, the diff destination (or target). When the source and
target is selected, a diff window slides in from the right. The diff window presents
the diff of the two buffers, relative to 'target'. The three buffers navigate in sync,
one may inspect them and edit the source and the target. The position sync is somewhat
intelligent by guessing the correct position of the cursor on the current buffer.
One can re-diff the buffers by right clicking on the tab header, and select re-diff.
Please note, that this diff is somewhat simple, as it marks only --del --ins points.
Again, its simplicity yields benefits that are surprizing. For instance; hand
merging small changes become more visual. And yes, it is no substitute for a real diff.

 The diff buffer (grayed) is read only. To refresh the diff, select
from the tab's right click menu 'Re-diff buffers'. The diff-ing can be stopped from the
same right click menu, by selecting 'Stop Diffing'. The diff algorithm is crude, but
the simplicity has its advantages. Speed and predictability.

  PyEdPro.py has macro recording/play, search/replace, one click function navigation,
auto backup, undo/redo, auto complete, auto correct, syntax check, spell suggestion
 ... and a lot more.

   The recorded macros, undo / redo information / editing session detail persists
 (and reloaded) after the editor is closed.

 The spell checker can check text, code and code comments. The parsing of the code is
rudimentary,  comments and strings are spell checked. (Press F9) The code is filtered
out for Python and  'C', which assures most derivative languages have correct
code spell code check. (.sh .php .cpp) The whole file can be checked in full text
spell mode. Press (Shift-F9) The spell checker is executed on live text. (while typing) The
re scan period is set to 300 milli seconds, an optimum between resource usage and real time feel.

  Syntax highlighting. Again, a simpler parser for speed. Succeeds in its mission with
giving great visual candy effect without speed impact.

  PyEdPro is fast, it is extendable, as python lends itself to easy extending. The
editor has a table driven key mapping. One can easily edit the key map in
keyhand.py, and the key actions in acthand.py

 If you encounter blank screen after start, cairo is not installed. The terminal interface
will complain, but if you start from the GUI, you can see the message in the
log window. (Menu->Windows->Show_Log) To install cairo type 'sudo apt install cairo'.

 The default key map resembles gedit / wed / etp / brief. Full ASCII;
 Any (fixed) font can be configured. No arrangements in the program for variable pitch fonts.

  See KEYS file for the list of keyboard shortcuts or press F1 in the
editor or look at the file in pyedlib/KEYS. This file is also called up when the main menu
 Help -> 'KeyHelp In Doc' is called up.

  If you highlight a word, and press F2, Zeal will open with the item searched and
highlighted. Shift F2 will do the same with Devhelp. This is what I use to see the
 API of PyGobj. F1 will call up the PyEdPro's help screen. Shift-F1 will open
DevDocs. Naturally, Devdocs/Devhelp/Zeal need to be installed for these to function.

  On initial start, PyEdPro shows a left pane and a top pane. The left pane
is for function summary and the top pane is for double view of the same file.
(to see the caller and the called [function] at once) These panes can be hidden with
the mouse by dragging on their handle, or by the key combination Alt-Q (Shift-Alt-Q for
the left pane) The first file window's settings are saved for the next startup.

  PyEdPro remembers a lot about the editing session. Loaded files, cursor positions,
fonts, font size, colors, search strings, goto numbers, undo / redo info,
window positions ... and more.

 This is all stored in the ~/.PyEdPro directory. You may safely delete that
directory to start PyEdPro with no memory of what has been done.

 PyEdPro also keeps a stack of original files in the ~/PyEdPro/data directory. The file
 path is treated as a name hash, so it is a flat list. For example this file is known to the
PyEdPro hash function as '754ad753_. Under this hash name there are a multitude of items.
The original file, the numbered backups (from _1 to _9, circular) the undo file,
redo file, the auto save (.sav) file, the backup file ).bak) from this session start
... and more.
The way to find the file's hash is to switch buffers and the current buffer's hash
is displayed on the status line.

  Starting PyEdPro with no command line arguments will put you back to the
previous session, exactly where you left off. Files, positions undo-s and all.

 The editor will work on all PyGobject platforms, and can open UNIX and Windows files
transparently. It will save the file as the current platform's native CRLF
convention dictates. CRLF setting can also be forced.

  Developer's note: in order to make PyEdPro multi platform, we save
the configuration info into a SQLite database in the ~/.PyEdPro directory.
SqliteBrowser may be a tool to see what is going on.

(~/ user's home directory)

 Contributors are welcome.

The author,

      Peter Glen

Newer screen shot, showing DIFF and other new features

![Screen Shot of DIFF](https://github.com/pglen/pyedpro/raw/master/diffscr.png)

Screen from a regular session, including clip buttons ...

![Screen Shot Ubuntu](https://github.com/pglen/pyedpro/raw/master/screen.png)

Screen from an older session, note the function list on the left:

![Screen Shot More](https://github.com/pglen/pyedpro/raw/master/image.png)

Screen from Mac:

(This has not been tested for a while)

![Screen Shot](https://github.com/pglen/pyedpro/raw/master/screen_shot_mac.png)

## Project stats:

    Project Name	pyedpro
    Generated On	2025-09-15 18:03:50 (in 33 seconds)
    Generated By	gitstats 0.7.3, git version 2.34.1, None
    Report Period	2018-09-16 11:29:10 to 2025-08-27 15:58:35
    Project Age	2538 days, 238 active days (9.38%)
    Total Files	3049
    Total Lines of Code	702286 (7154741 added, 6452455 removed)
    Total Commits	783 (average 3.3 commits per active day, 0.3 per all days)
    Authors	7 (average 111.9 commits per author)

![Stats](https://github.com/pglen/pyedpro/raw/master/commits_by_year_month.png)

## License:

    Open Source, FreeWare, Unlicence, MIT at your convenience

// EOF

