snapmockit 1.2.0__tar.gz

snapmockit-1.2.0/.gitignore

@@ -0,0 +1,42 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+
+# Distribution / packaging
+dist/
+build/
+*.egg-info/
+*.egg
+
+# Virtual environments
+.venv/
+
+# Type checking
+.mypy_cache/
+
+# Linting
+.ruff_cache/
+
+# Testing
+.pytest_cache/
+htmlcov/
+.coverage
+coverage.xml
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db
+
+PRDs/.~lock.SnapMock-General-UI-PRD.docx#
+
+*.snagx
+
+Example Snag Files/2020-04-25_10-26-43.MP4

snapmockit-1.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Doug Bower
+
+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.

snapmockit-1.2.0/PKG-INFO

@@ -0,0 +1,179 @@
+Metadata-Version: 2.5
+Name: snapmockit
+Version: 1.2.0
+Summary: Snapmockit: open-source multi-platform screenshot annotation and UI mockup tool
+Project-URL: Homepage, https://github.com/dbower44022/snapmockit
+Project-URL: Documentation, https://github.com/dbower44022/snapmockit#readme
+Project-URL: Repository, https://github.com/dbower44022/snapmockit
+Project-URL: Issues, https://github.com/dbower44022/snapmockit/issues
+Project-URL: Changelog, https://github.com/dbower44022/snapmockit/releases
+Author: Doug Bower
+License-Expression: MIT
+License-File: LICENSE
+Keywords: annotation,image editor,mockup,qt,screen capture,screenshot,snagit
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: X11 Applications :: Qt
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Multimedia :: Graphics
+Classifier: Topic :: Multimedia :: Graphics :: Capture :: Screen Capture
+Classifier: Topic :: Multimedia :: Graphics :: Editors :: Vector-Based
+Requires-Python: >=3.12
+Requires-Dist: numpy>=1.24
+Requires-Dist: pillow>=10.0
+Requires-Dist: psutil>=7.2.2
+Requires-Dist: pyqt6>=6.5
+Requires-Dist: send2trash>=2.1.0
+Description-Content-Type: text/markdown
+
+# Snapmockit
+
+Snapmockit is an open-source screenshot annotation and user interface mockup tool for Linux, Windows, and macOS, written in Python with PyQt6. Capture a screen, a window, or a region; annotate it with shapes, arrows, text, callouts, highlights, blur, numbered steps, stamps, and emoji on layers; then export it as PNG, JPEG, SVG, or PDF, or save it as a project to come back to. It reads and writes Snagit's `.snagx` files.
+
+Status: the application is complete against its nine product requirements documents (the `PRDs/` directory). Release 1.2.0 installs from the Python Package Index on any platform with Python 3.12 or later, and on Linux also ships as an AppImage and a Flatpak bundle. The Windows and macOS capture backends are written but have not yet been tested on those machines.
+
+## Install from the Python Package Index (any platform)
+
+With Python 3.12 or later, install Snapmockit as an application of its own with [pipx](https://pipx.pypa.io/) or [uv](https://docs.astral.sh/uv/):
+
+```bash
+pipx install snapmockit
+```
+
+```bash
+uv tool install snapmockit
+```
+
+Either puts a `snapmockit` command on your path; start the application with it. `snapmockit --version` prints the version, and `snapmockit --capture full` takes a capture straight away and opens it. `pip install snapmockit` into a virtual environment works too.
+
+To upgrade, use the tool you installed with: `pipx upgrade snapmockit`, `uv tool upgrade snapmockit`, or `pip install --upgrade snapmockit`. Help > Check for Updates names the right one when a new release is out.
+
+On Linux, Qt needs the same system libraries the AppImage lists below, which every desktop installation has. The package installs no menu entry or icon; start it from a terminal or bind the command to a key. Windows and macOS installations run, but the screen capture backends for both are untested.
+
+## Install on Linux
+
+Snapmockit ships in two forms on Linux, both for x86_64: an **AppImage**, one file that carries its own Python and Qt, and a **Flatpak**, a 26 MB bundle that runs on the KDE runtime and in a sandbox. Neither needs a package manager or a password. The AppImage runs anywhere with glibc 2.34 or later (Ubuntu 22.04, Debian 12, Fedora 35, RHEL 9, and later); the Flatpak runs anywhere Flatpak does.
+
+### The AppImage
+
+1. Download `Snapmockit-<version>-x86_64.AppImage` from the latest release at https://github.com/dbower44022/snapmockit/releases.
+2. Make it executable and run it. From a file manager, right-click the file, allow it to run as a program under Properties, and double-click it. From a terminal, with the file in your Downloads folder:
+
+```bash
+chmod +x ~/Downloads/Snapmockit-*.AppImage
+~/Downloads/Snapmockit-*.AppImage
+```
+
+`--version` prints the version, `--capture full` takes a capture straight away and opens it, and a project file named on the command line opens. Help > Check for Updates in the application reads the latest release.
+
+The file needs these libraries from the system, which every desktop installation has and a bare server may not: on Debian and Ubuntu, `libegl1 libgl1 libglib2.0-0 libdbus-1-3 libfontconfig1 libfreetype6 libxkbcommon0 libxkbcommon-x11-0 libxcb-cursor0 libxcb-icccm4 libxcb-keysyms1 libxcb-shape0 libxcb-xkb1 libxcb-render-util0 libxcb-image0 libx11-6 libxfixes3`, plus `libwayland-client0` and `xdg-desktop-portal` with a backend for your desktop under Wayland. Fonts, the colour emoji font included, come from the system. Settings live under `~/.config/Snapmockit`, presets and themes under `~/.config/snapmockit`, and the library at `~/Snapmockit/Library` unless you moved it; a first start moves what earlier builds kept under the SnapMock name and says so once.
+
+### Putting it in the menu
+
+The file carries its menu entry and icon but does not install them yet. To have Snapmockit in the desktop's main menu, copy the file to a fixed name, take the icons out of it, and write an entry that points at the copy:
+
+```bash
+mkdir -p ~/Applications ~/.local/share/applications ~/.local/share/icons/hicolor/256x256/apps ~/.local/share/icons/hicolor/scalable/apps
+cp ~/Downloads/Snapmockit-*.AppImage ~/Applications/Snapmockit.AppImage
+(cd /tmp && ~/Applications/Snapmockit.AppImage --appimage-extract 'usr/share/icons/hicolor/*/apps/*')
+cp /tmp/squashfs-root/usr/share/icons/hicolor/256x256/apps/io.github.dbower44022.snapmockit.png ~/.local/share/icons/hicolor/256x256/apps/
+cp /tmp/squashfs-root/usr/share/icons/hicolor/scalable/apps/io.github.dbower44022.snapmockit.svg ~/.local/share/icons/hicolor/scalable/apps/
+rm -rf /tmp/squashfs-root
+cat > ~/.local/share/applications/io.github.dbower44022.snapmockit.desktop <<EOF
+[Desktop Entry]
+Type=Application
+Name=Snapmockit
+GenericName=Screenshot Annotation Tool
+Comment=Capture, annotate, and mock up screenshots
+Exec=$HOME/Applications/Snapmockit.AppImage %F
+Icon=io.github.dbower44022.snapmockit
+Terminal=false
+Categories=Graphics;Utility;
+MimeType=application/x-snapmockit-project;
+Keywords=screenshot;capture;annotate;mockup;
+StartupNotify=true
+StartupWMClass=Snapmockit
+EOF
+update-desktop-database ~/.local/share/applications
+```
+
+The entry appears at once; if its icon does not, the running desktop has not rescanned its icon folders yet, and a restart of the desktop shell (Ctrl+Alt+Esc on Cinnamon under X11) or a fresh login shows it. A later release replaces the copy at `~/Applications/Snapmockit.AppImage` and the entry stays. To remove it, delete the entry file, the two icon files, and the copy.
+
+### The Flatpak
+
+```bash
+cd ~/Downloads
+flatpak install --user Snapmockit-<version>-x86_64.flatpak
+flatpak run io.github.dbower44022.snapmockit
+```
+
+Download the bundle from the same release page. The first install offers to fetch the KDE runtime 6.11 from Flathub, which is most of what the application needs; the bundle itself is 26 MB because Qt is shared with every other KDE application on the machine. The desktop entry and the icon are installed with it, so Snapmockit is in the main menu at once, and `flatpak run io.github.dbower44022.snapmockit --capture full` is the command to bind to a key.
+
+The sandbox reaches your whole home directory, the display, the graphics device, and the network, and nothing else. Its settings live under `~/.var/app/io.github.dbower44022.snapmockit/`, copied once from `~/.config/Snapmockit` on the first start if you have been running another form; the library is the same `~/Snapmockit/Library` both forms use. A bundle installed by hand does not update itself: a new version is a new download. Both forms can be installed at once, but they carry one application id, so the desktop shows one menu entry for Snapmockit.
+
+### Other forms
+
+Windows and macOS have no package of their own yet; install from the Python Package Index (above) or run from source. The capture backends for both are written but untested. The Flatpak is published as the bundle above and not on Flathub.
+
+## Running from source
+
+Requirements: Python 3.12 or later and [uv](https://docs.astral.sh/uv/).
+
+```bash
+git clone https://github.com/dbower44022/snapmockit.git
+cd snapmockit
+uv sync
+uv run python -m snapmock
+```
+
+To take a capture straight from the command line and open it in the application:
+
+```bash
+uv run python -m snapmock --capture full
+```
+
+## Building the packages
+
+The release job builds both Linux forms from a clean runner on every tag, and both recipes run from a checkout with one command each, landing under `dist/`.
+
+The AppImage:
+
+```bash
+uv sync --group packaging
+uv run --group packaging python packaging/appimage/build.py
+```
+
+The Flatpak, which needs `flatpak-builder` (or Flathub's `org.flatpak.Builder`), the KDE runtime 6.11 with its SDK, the PyQt base application 6.11, and an SVG loader on the machine that builds:
+
+```bash
+flatpak install flathub org.kde.Platform//6.11 org.kde.Sdk//6.11 \
+  com.riverbankcomputing.PyQt.BaseApp//6.11
+uv run python packaging/flatpak/build.py
+```
+
+`packaging/flatpak/build.py --update-deps` regenerates the dependency module from `uv.lock` when a dependency changes.
+
+## Developing
+
+```bash
+uv run pytest            # the test suite, about 6 minutes; QT_QPA_PLATFORM=offscreen for a headless run
+uv run ruff check .      # lint
+uv run ruff format .     # format
+uv run mypy snapmock     # type check, strict
+```
+
+The product requirements documents under `PRDs/` are the single source of truth for behaviour; `docs/` holds the implementation notes and kickoff prompts each piece of work was built from; `CLAUDE.md` holds the working conventions.
+
+## Reporting a problem
+
+Open an issue at https://github.com/dbower44022/snapmockit/issues. Help > About > Copy Version Info in the application puts the version, the build date, and the platform on the clipboard for the report.
+
+## Licence
+
+MIT. Copyright (c) 2026 Doug Bower. Icons are [Tabler Icons](https://tabler.io/icons) by Paweł Kuna, MIT.

snapmockit-1.2.0/README.md

@@ -0,0 +1,145 @@
+# Snapmockit
+
+Snapmockit is an open-source screenshot annotation and user interface mockup tool for Linux, Windows, and macOS, written in Python with PyQt6. Capture a screen, a window, or a region; annotate it with shapes, arrows, text, callouts, highlights, blur, numbered steps, stamps, and emoji on layers; then export it as PNG, JPEG, SVG, or PDF, or save it as a project to come back to. It reads and writes Snagit's `.snagx` files.
+
+Status: the application is complete against its nine product requirements documents (the `PRDs/` directory). Release 1.2.0 installs from the Python Package Index on any platform with Python 3.12 or later, and on Linux also ships as an AppImage and a Flatpak bundle. The Windows and macOS capture backends are written but have not yet been tested on those machines.
+
+## Install from the Python Package Index (any platform)
+
+With Python 3.12 or later, install Snapmockit as an application of its own with [pipx](https://pipx.pypa.io/) or [uv](https://docs.astral.sh/uv/):
+
+```bash
+pipx install snapmockit
+```
+
+```bash
+uv tool install snapmockit
+```
+
+Either puts a `snapmockit` command on your path; start the application with it. `snapmockit --version` prints the version, and `snapmockit --capture full` takes a capture straight away and opens it. `pip install snapmockit` into a virtual environment works too.
+
+To upgrade, use the tool you installed with: `pipx upgrade snapmockit`, `uv tool upgrade snapmockit`, or `pip install --upgrade snapmockit`. Help > Check for Updates names the right one when a new release is out.
+
+On Linux, Qt needs the same system libraries the AppImage lists below, which every desktop installation has. The package installs no menu entry or icon; start it from a terminal or bind the command to a key. Windows and macOS installations run, but the screen capture backends for both are untested.
+
+## Install on Linux
+
+Snapmockit ships in two forms on Linux, both for x86_64: an **AppImage**, one file that carries its own Python and Qt, and a **Flatpak**, a 26 MB bundle that runs on the KDE runtime and in a sandbox. Neither needs a package manager or a password. The AppImage runs anywhere with glibc 2.34 or later (Ubuntu 22.04, Debian 12, Fedora 35, RHEL 9, and later); the Flatpak runs anywhere Flatpak does.
+
+### The AppImage
+
+1. Download `Snapmockit-<version>-x86_64.AppImage` from the latest release at https://github.com/dbower44022/snapmockit/releases.
+2. Make it executable and run it. From a file manager, right-click the file, allow it to run as a program under Properties, and double-click it. From a terminal, with the file in your Downloads folder:
+
+```bash
+chmod +x ~/Downloads/Snapmockit-*.AppImage
+~/Downloads/Snapmockit-*.AppImage
+```
+
+`--version` prints the version, `--capture full` takes a capture straight away and opens it, and a project file named on the command line opens. Help > Check for Updates in the application reads the latest release.
+
+The file needs these libraries from the system, which every desktop installation has and a bare server may not: on Debian and Ubuntu, `libegl1 libgl1 libglib2.0-0 libdbus-1-3 libfontconfig1 libfreetype6 libxkbcommon0 libxkbcommon-x11-0 libxcb-cursor0 libxcb-icccm4 libxcb-keysyms1 libxcb-shape0 libxcb-xkb1 libxcb-render-util0 libxcb-image0 libx11-6 libxfixes3`, plus `libwayland-client0` and `xdg-desktop-portal` with a backend for your desktop under Wayland. Fonts, the colour emoji font included, come from the system. Settings live under `~/.config/Snapmockit`, presets and themes under `~/.config/snapmockit`, and the library at `~/Snapmockit/Library` unless you moved it; a first start moves what earlier builds kept under the SnapMock name and says so once.
+
+### Putting it in the menu
+
+The file carries its menu entry and icon but does not install them yet. To have Snapmockit in the desktop's main menu, copy the file to a fixed name, take the icons out of it, and write an entry that points at the copy:
+
+```bash
+mkdir -p ~/Applications ~/.local/share/applications ~/.local/share/icons/hicolor/256x256/apps ~/.local/share/icons/hicolor/scalable/apps
+cp ~/Downloads/Snapmockit-*.AppImage ~/Applications/Snapmockit.AppImage
+(cd /tmp && ~/Applications/Snapmockit.AppImage --appimage-extract 'usr/share/icons/hicolor/*/apps/*')
+cp /tmp/squashfs-root/usr/share/icons/hicolor/256x256/apps/io.github.dbower44022.snapmockit.png ~/.local/share/icons/hicolor/256x256/apps/
+cp /tmp/squashfs-root/usr/share/icons/hicolor/scalable/apps/io.github.dbower44022.snapmockit.svg ~/.local/share/icons/hicolor/scalable/apps/
+rm -rf /tmp/squashfs-root
+cat > ~/.local/share/applications/io.github.dbower44022.snapmockit.desktop <<EOF
+[Desktop Entry]
+Type=Application
+Name=Snapmockit
+GenericName=Screenshot Annotation Tool
+Comment=Capture, annotate, and mock up screenshots
+Exec=$HOME/Applications/Snapmockit.AppImage %F
+Icon=io.github.dbower44022.snapmockit
+Terminal=false
+Categories=Graphics;Utility;
+MimeType=application/x-snapmockit-project;
+Keywords=screenshot;capture;annotate;mockup;
+StartupNotify=true
+StartupWMClass=Snapmockit
+EOF
+update-desktop-database ~/.local/share/applications
+```
+
+The entry appears at once; if its icon does not, the running desktop has not rescanned its icon folders yet, and a restart of the desktop shell (Ctrl+Alt+Esc on Cinnamon under X11) or a fresh login shows it. A later release replaces the copy at `~/Applications/Snapmockit.AppImage` and the entry stays. To remove it, delete the entry file, the two icon files, and the copy.
+
+### The Flatpak
+
+```bash
+cd ~/Downloads
+flatpak install --user Snapmockit-<version>-x86_64.flatpak
+flatpak run io.github.dbower44022.snapmockit
+```
+
+Download the bundle from the same release page. The first install offers to fetch the KDE runtime 6.11 from Flathub, which is most of what the application needs; the bundle itself is 26 MB because Qt is shared with every other KDE application on the machine. The desktop entry and the icon are installed with it, so Snapmockit is in the main menu at once, and `flatpak run io.github.dbower44022.snapmockit --capture full` is the command to bind to a key.
+
+The sandbox reaches your whole home directory, the display, the graphics device, and the network, and nothing else. Its settings live under `~/.var/app/io.github.dbower44022.snapmockit/`, copied once from `~/.config/Snapmockit` on the first start if you have been running another form; the library is the same `~/Snapmockit/Library` both forms use. A bundle installed by hand does not update itself: a new version is a new download. Both forms can be installed at once, but they carry one application id, so the desktop shows one menu entry for Snapmockit.
+
+### Other forms
+
+Windows and macOS have no package of their own yet; install from the Python Package Index (above) or run from source. The capture backends for both are written but untested. The Flatpak is published as the bundle above and not on Flathub.
+
+## Running from source
+
+Requirements: Python 3.12 or later and [uv](https://docs.astral.sh/uv/).
+
+```bash
+git clone https://github.com/dbower44022/snapmockit.git
+cd snapmockit
+uv sync
+uv run python -m snapmock
+```
+
+To take a capture straight from the command line and open it in the application:
+
+```bash
+uv run python -m snapmock --capture full
+```
+
+## Building the packages
+
+The release job builds both Linux forms from a clean runner on every tag, and both recipes run from a checkout with one command each, landing under `dist/`.
+
+The AppImage:
+
+```bash
+uv sync --group packaging
+uv run --group packaging python packaging/appimage/build.py
+```
+
+The Flatpak, which needs `flatpak-builder` (or Flathub's `org.flatpak.Builder`), the KDE runtime 6.11 with its SDK, the PyQt base application 6.11, and an SVG loader on the machine that builds:
+
+```bash
+flatpak install flathub org.kde.Platform//6.11 org.kde.Sdk//6.11 \
+  com.riverbankcomputing.PyQt.BaseApp//6.11
+uv run python packaging/flatpak/build.py
+```
+
+`packaging/flatpak/build.py --update-deps` regenerates the dependency module from `uv.lock` when a dependency changes.
+
+## Developing
+
+```bash
+uv run pytest            # the test suite, about 6 minutes; QT_QPA_PLATFORM=offscreen for a headless run
+uv run ruff check .      # lint
+uv run ruff format .     # format
+uv run mypy snapmock     # type check, strict
+```
+
+The product requirements documents under `PRDs/` are the single source of truth for behaviour; `docs/` holds the implementation notes and kickoff prompts each piece of work was built from; `CLAUDE.md` holds the working conventions.
+
+## Reporting a problem
+
+Open an issue at https://github.com/dbower44022/snapmockit/issues. Help > About > Copy Version Info in the application puts the version, the build date, and the platform on the clipboard for the report.
+
+## Licence
+
+MIT. Copyright (c) 2026 Doug Bower. Icons are [Tabler Icons](https://tabler.io/icons) by Paweł Kuna, MIT.