miniword 0.1.0__tar.gz

miniword-0.1.0/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

miniword-0.1.0/PKG-INFO

@@ -0,0 +1,167 @@
+Metadata-Version: 2.4
+Name: miniword
+Version: 0.1.0
+Summary: A minimal word processor in Python
+License-Expression: LGPL-3.0-or-later
+Project-URL: Homepage, https://codeberg.org/chrisecker/miniword
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: wxPython>=4.0
+Requires-Dist: cairocffi
+Dynamic: license-file
+
+# MiniWord
+
+A minimal word processor in python. In development but already great.
+
+![Screenshot](https://codeberg.org/chrisecker/miniword/raw/branch/main/screenshots/miniword_18jun26.png)
+
+## Key Aspects
+
+- Real WYSIWYG editing (no HTML layer, no embedded browser)
+- Lightweight and fast startup
+- Clean, simple file format (human-readable, diff-friendly, git-friendly, AI-friendly)
+- Good Markdown support
+- Extensible via Python-plugins
+
+## Download
+
+Pre-built installers for Windows (`.exe`) and macOS (`.dmg`) are published on the [Releases page](https://github.com/chrisecker/miniword/releases) for each tagged version. On Linux, install from source via `pip` (see below) — no separate installer is provided there.
+
+## Dependencies
+
+Miniword is developed under Linux. In principle it should run under Windows and Mac as well. 
+
+Dependencies vary between platforms and prefered features. You always need Python >= 3.9 and wxPython >= 4.0.
+
+| Dependency | Linux    | Windows  | macOS    | Notes                                      |
+| ---------- | -------- | -------- | -------- | ------------------------------------------ |
+| cairocffi  | required | required | required | pulled in automatically by `pip install .` |
+| fontconfig | required | —        | required | system CLI-tool                            |
+| uharfbuzz  | optional | optional | optional | needed for ligatures and non-Latin scripts |
+| fonttools  | —        | optional | —        | needed for non-Latin scripts on Windows    |
+| mistune    | optional | optional | optional | richer Markdown import; falls back to a built-in parser |
+
+## Running without installation
+
+```
+python miniword.py
+```
+
+Alternatively, double-click `miniword.py` in your file explorer.
+
+## Install (Linux)
+
+Install system dependencies:
+
+```
+sudo apt install python3-wxgtk4.0 fontconfig
+```
+
+For ligature support, non-Latin scripts, and richer Markdown import, install the optional extras:
+
+```
+pip install uharfbuzz mistune
+```
+
+Then install miniword (this also pulls in `cairocffi`):
+
+```
+cd miniword
+pip install .
+```
+
+If you want to register MiniWord to the desktop (you probably will):
+
+```
+cp miniword/icons/miniword.svg ~/.local/share/icons/
+cp miniword.desktop ~/.local/share/applications/
+```
+
+## Install (Windows)
+
+Prefer a ready-made installer? Download the `.exe` from the [Releases page](https://github.com/chrisecker/miniword/releases) instead of building from source.
+
+No separate Cairo installation is needed — wxPython already bundles `libcairo-2.dll`, and `pip install .` pulls in `cairocffi` to bind to it.
+
+```
+cd miniword
+pip install .
+pip install uharfbuzz fonttools mistune   # optional: ligatures, non-Latin scripts, richer Markdown import
+```
+
+MiniWord stores its configuration and plugins in `%APPDATA%\miniword\` (e.g. `C:\Users\<you>\AppData\Roaming\miniword\`).
+
+**Note** that MiniWord is not yet **optimised** for Windows. While it mostly works, the GUI is less polished and startup takes a bit longer.
+
+## Install (macOS)
+
+Prefer a ready-made installer? Download the `.dmg` from the [Releases page](https://github.com/chrisecker/miniword/releases) instead of building from source.
+
+On macOS, `fontconfig` must be installed via Homebrew:
+
+```
+brew install fontconfig
+```
+
+Then install miniword (this also pulls in `cairocffi`):
+
+```
+cd miniword
+pip install .
+pip install uharfbuzz mistune   # optional: ligatures, non-Latin scripts, richer Markdown import
+```
+
+MiniWord stores its configuration and plugins in `~/Library/Application Support/miniword/`.
+
+**Note** that MiniWord has not been tested on macOS.
+
+## Hacking
+
+Run the full test suite:
+
+```
+python test_all.py
+```
+
+Run tests for a single module:
+
+```
+python runtests.py miniword/layout/pagegen.py
+```
+
+Run a specific test or demo:
+
+```
+python runtests.py miniword/ui/searchtool.py test_00
+python runtests.py miniword/texteditor/textcanvas.py demo_00
+```
+
+## Plugins
+
+MiniWord is extensible via Python plugins. To install a plugin, copy the `.py` file into the plugins directory for your platform:
+
+| Platform | Plugins directory                                 |
+| -------- | ------------------------------------------------- |
+| Linux    | `~/.config/miniword/plugins/`                     |
+| macOS    | `~/Library/Application Support/miniword/plugins/` |
+| Windows  | `%APPDATA%\miniword\plugins\`                     |
+
+Example plugins are provided in the `examples/` directory:
+
+| File            | Description                           |
+| --------------- | ------------------------------------- |
+| `wordcount.py`  | Shows a live word count               |
+| `txtfilter.py`  | Filter for importing plain text files |
+
+To install all example plugins on Linux:
+
+```
+mkdir -p ~/.config/miniword/plugins
+cp examples/*.py ~/.config/miniword/plugins
+```
+
+## License
+
+This project is licensed under the GNU General Public License v3.0 - see LICENSE for details. Contact me if you need something else.

miniword-0.1.0/README.md

@@ -0,0 +1,154 @@
+# MiniWord
+
+A minimal word processor in python. In development but already great.
+
+![Screenshot](https://codeberg.org/chrisecker/miniword/raw/branch/main/screenshots/miniword_18jun26.png)
+
+## Key Aspects
+
+- Real WYSIWYG editing (no HTML layer, no embedded browser)
+- Lightweight and fast startup
+- Clean, simple file format (human-readable, diff-friendly, git-friendly, AI-friendly)
+- Good Markdown support
+- Extensible via Python-plugins
+
+## Download
+
+Pre-built installers for Windows (`.exe`) and macOS (`.dmg`) are published on the [Releases page](https://github.com/chrisecker/miniword/releases) for each tagged version. On Linux, install from source via `pip` (see below) — no separate installer is provided there.
+
+## Dependencies
+
+Miniword is developed under Linux. In principle it should run under Windows and Mac as well. 
+
+Dependencies vary between platforms and prefered features. You always need Python >= 3.9 and wxPython >= 4.0.
+
+| Dependency | Linux    | Windows  | macOS    | Notes                                      |
+| ---------- | -------- | -------- | -------- | ------------------------------------------ |
+| cairocffi  | required | required | required | pulled in automatically by `pip install .` |
+| fontconfig | required | —        | required | system CLI-tool                            |
+| uharfbuzz  | optional | optional | optional | needed for ligatures and non-Latin scripts |
+| fonttools  | —        | optional | —        | needed for non-Latin scripts on Windows    |
+| mistune    | optional | optional | optional | richer Markdown import; falls back to a built-in parser |
+
+## Running without installation
+
+```
+python miniword.py
+```
+
+Alternatively, double-click `miniword.py` in your file explorer.
+
+## Install (Linux)
+
+Install system dependencies:
+
+```
+sudo apt install python3-wxgtk4.0 fontconfig
+```
+
+For ligature support, non-Latin scripts, and richer Markdown import, install the optional extras:
+
+```
+pip install uharfbuzz mistune
+```
+
+Then install miniword (this also pulls in `cairocffi`):
+
+```
+cd miniword
+pip install .
+```
+
+If you want to register MiniWord to the desktop (you probably will):
+
+```
+cp miniword/icons/miniword.svg ~/.local/share/icons/
+cp miniword.desktop ~/.local/share/applications/
+```
+
+## Install (Windows)
+
+Prefer a ready-made installer? Download the `.exe` from the [Releases page](https://github.com/chrisecker/miniword/releases) instead of building from source.
+
+No separate Cairo installation is needed — wxPython already bundles `libcairo-2.dll`, and `pip install .` pulls in `cairocffi` to bind to it.
+
+```
+cd miniword
+pip install .
+pip install uharfbuzz fonttools mistune   # optional: ligatures, non-Latin scripts, richer Markdown import
+```
+
+MiniWord stores its configuration and plugins in `%APPDATA%\miniword\` (e.g. `C:\Users\<you>\AppData\Roaming\miniword\`).
+
+**Note** that MiniWord is not yet **optimised** for Windows. While it mostly works, the GUI is less polished and startup takes a bit longer.
+
+## Install (macOS)
+
+Prefer a ready-made installer? Download the `.dmg` from the [Releases page](https://github.com/chrisecker/miniword/releases) instead of building from source.
+
+On macOS, `fontconfig` must be installed via Homebrew:
+
+```
+brew install fontconfig
+```
+
+Then install miniword (this also pulls in `cairocffi`):
+
+```
+cd miniword
+pip install .
+pip install uharfbuzz mistune   # optional: ligatures, non-Latin scripts, richer Markdown import
+```
+
+MiniWord stores its configuration and plugins in `~/Library/Application Support/miniword/`.
+
+**Note** that MiniWord has not been tested on macOS.
+
+## Hacking
+
+Run the full test suite:
+
+```
+python test_all.py
+```
+
+Run tests for a single module:
+
+```
+python runtests.py miniword/layout/pagegen.py
+```
+
+Run a specific test or demo:
+
+```
+python runtests.py miniword/ui/searchtool.py test_00
+python runtests.py miniword/texteditor/textcanvas.py demo_00
+```
+
+## Plugins
+
+MiniWord is extensible via Python plugins. To install a plugin, copy the `.py` file into the plugins directory for your platform:
+
+| Platform | Plugins directory                                 |
+| -------- | ------------------------------------------------- |
+| Linux    | `~/.config/miniword/plugins/`                     |
+| macOS    | `~/Library/Application Support/miniword/plugins/` |
+| Windows  | `%APPDATA%\miniword\plugins\`                     |
+
+Example plugins are provided in the `examples/` directory:
+
+| File            | Description                           |
+| --------------- | ------------------------------------- |
+| `wordcount.py`  | Shows a live word count               |
+| `txtfilter.py`  | Filter for importing plain text files |
+
+To install all example plugins on Linux:
+
+```
+mkdir -p ~/.config/miniword/plugins
+cp examples/*.py ~/.config/miniword/plugins
+```
+
+## License
+
+This project is licensed under the GNU General Public License v3.0 - see LICENSE for details. Contact me if you need something else.

miniword-0.1.0/miniword/__init__.py

@@ -0,0 +1 @@
+import wx.lib.wxcairo as wxcairo

miniword-0.1.0/miniword/__main__.py

@@ -0,0 +1,76 @@
+import sys
+import wx
+from .core.document import Document
+from .core.config import get_config
+from .ui.mainwindow import MainFrame
+from .ui.unitentry import LengthInput, UnitPrefs
+from .layout import pagebuilder
+
+
+def _enable_dpi_awareness():
+    """Enable Per-Monitor DPI awareness on Windows to avoid blurry rendering."""
+    if sys.platform != 'win32':
+        return
+    try:
+        import ctypes
+        ctypes.windll.shcore.SetProcessDpiAwareness(2)  # Per-Monitor DPI aware
+    except Exception:
+        try:
+            ctypes.windll.user32.SetProcessDPIAware()
+        except Exception:
+            pass
+
+def _enable_dpi_awareness():
+    """Enable Per-Monitor DPI awareness v2 on Windows."""
+    if sys.platform != 'win32':
+        return
+    try:
+        # Windows 10 v1703+: Using SetProcessDpiAwarenessContext mit v2
+        # -4 entspricht DPI_AWARENESS_CONTEXT_PER_MONITOR_AWARE_V2
+        ctypes.windll.user32.SetProcessDpiAwarenessContext(-4)
+    except Exception:
+        try:
+            # Fallback for Windows 8.1 / early Win 10 (2 = Process_Per_Monitor_DPI_Aware)
+            ctypes.windll.shcore.SetProcessDpiAwareness(2)
+        except Exception:
+            try:
+                # Fallback for Windows Vista / 7
+                ctypes.windll.user32.SetProcessDPIAware()
+            except Exception:
+                pass
+            
+def main():
+    args = sys.argv[1:]
+    if '--debug' in args:
+        pagebuilder.DEBUG = True
+        args = [a for a in args if a != '--debug']
+    path = args[0] if args else None
+
+    _enable_dpi_awareness()
+    config = get_config()
+    LengthInput.prefs = UnitPrefs(
+        layout=config.get("layout_unit"),
+        typographic=config.get("typographic_unit"),
+    )
+    app = wx.App(redirect=False)
+    app.SetAppName("miniword")
+    from .ui.mainwindow import load_plugins
+    load_plugins()
+    if path:
+        from .io import importexport
+        try:
+            doc = importexport.open_file(path)
+        except Exception as e:
+            print("Error opening '%s': %s" % (path, e))
+            return
+        frame = MainFrame(doc)
+        frame._current_path = path
+        frame._update_title()
+    else:
+        frame = MainFrame(Document())
+    frame.Show()
+    app.MainLoop()
+
+
+if __name__ == '__main__':
+    main()

miniword-0.1.0/miniword/core/config.py

@@ -0,0 +1,34 @@
+import json
+from pathlib import Path
+
+_path = Path.home() / ".config" / "miniword" / "config.json"
+_defaults = {"layout_unit": "mm", "typographic_unit": "mm"}
+
+_instance = None
+
+
+def get_config():
+    global _instance
+    if _instance is None:
+        _instance = Config()
+    return _instance
+
+
+class Config:
+    """Persistent user preferences, stored in ~/.config/miniword/config.json."""
+
+    def __init__(self):
+        self._data = {**_defaults}
+        if _path.exists():
+            try:
+                self._data.update(json.loads(_path.read_text()))
+            except Exception:
+                pass
+
+    def get(self, key):
+        return self._data.get(key, _defaults.get(key))
+
+    def set(self, key, value):
+        self._data[key] = value
+        _path.parent.mkdir(parents=True, exist_ok=True)
+        _path.write_text(json.dumps(self._data, indent=2))

miniword-0.1.0/miniword/core/document.py

@@ -0,0 +1,90 @@
+from ..textmodel.modelbase import Model
+from ..textmodel.textmodel import TextModel
+from .stylesheet import StyleSheet
+from .units import cm, mm
+from .styles import normal as _normal_style
+
+
+settings_default = {
+    "title":         "",
+    "author":        "",
+    "paper":         "A4",        # "A4" / "Letter" / "custom"
+    "paper_width":   210 * mm,    # used when paper == "custom"
+    "paper_height":  297 * mm,
+    "margin_top":    2.5 * cm,
+    "margin_right":  2.5 * cm,
+    "margin_bottom": 2.5 * cm,
+    "margin_left":   2.5 * cm,
+}
+
+
+class Document(Model):
+    def __init__(self):
+        self.basestyles = StyleSheet()
+        self.basestyles.set_owner(self, 'basestyles')
+        self.basestyles.set('normal', _normal_style)
+        self.textmodel = TextModel()
+        self.settings = {}
+        self.blobs = {}        # {blob_id: bytes}
+        self.home_format = 'txl'   # native format; set to ext on import
+
+    def set_setting(self, name, value):
+        if name in self.settings:
+            old = self.settings[name]
+        else:
+            old = settings_default[name]
+        if value != old:
+            if settings_default[name] == value:
+                del self.settings[name]
+            else:
+                self.settings[name] = value
+            self.notify_views('setting_changed', name, old)
+        return old
+
+    def save(self, path):
+        from ..io import txlio
+        txlio.save(self, path)
+
+    @classmethod
+    def load(cls, path):
+        from ..io.importexport import open_file
+        return open_file(path)
+        
+    def basestyles_changed(self, *args, **kwds):
+        self.notify_views('basestyles_changed')
+        
+
+        
+class TestDocument(Document):
+    def attribute_changed(self, *args, **kwds):
+        self.msg = args, kwds
+
+
+def test_00():
+    "receiving child messages via fallback handler"
+    doc = TestDocument()
+    doc.xyzstyles = StyleSheet()
+    doc.xyzstyles.set_owner(doc, 'xyzstyles')
+    doc.msg = None
+    doc.xyzstyles.set("x", {})
+    assert doc.msg == ((doc.xyzstyles,), {})
+
+
+def test_01():
+    "forwarding basestyles changes to views"
+    from ..textmodel.viewbase import ViewBase
+
+    class TestView(ViewBase):
+        def basestyles_changed(self, *args, **kwds):
+            self.msg = "basestyles_changed", args, kwds
+
+        def model_changed(self, *args, **kwds):
+            self.msg = "model_changed", args, kwds
+
+    doc = Document()
+    view = TestView()
+    view.model = doc
+
+    doc.basestyles.set('normal', dict(fontsize=9, dolor="black"))
+    assert view.msg == ('basestyles_changed', (doc,), {})
+