{"id":13595482,"url":"https://github.com/1j01/textual-paint","last_synced_at":"2025-05-16T04:03:36.961Z","repository":{"id":158992365,"uuid":"626145619","full_name":"1j01/textual-paint","owner":"1j01","description":":art: MS Paint in your terminal.","archived":false,"fork":false,"pushed_at":"2024-11-11T21:28:25.000Z","size":5062,"stargazers_count":1021,"open_issues_count":6,"forks_count":15,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-05-16T04:02:52.519Z","etag":null,"topics":["ansi-art","ansi-editor","artscene","ascii-art","bbs","drawing","image","image-editor","irc","mirc","mspaint","paint","pixel-art","pixel-editor","terminal","text-art","textual","tui"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/textual-paint/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/1j01.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-04-10T22:26:49.000Z","updated_at":"2025-05-13T14:22:43.000Z","dependencies_parsed_at":"2025-05-16T04:02:55.547Z","dependency_job_id":null,"html_url":"https://github.com/1j01/textual-paint","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1j01%2Ftextual-paint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1j01%2Ftextual-paint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1j01%2Ftextual-paint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/1j01%2Ftextual-paint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/1j01","download_url":"https://codeload.github.com/1j01/textual-paint/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254464891,"owners_count":22075570,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ansi-art","ansi-editor","artscene","ascii-art","bbs","drawing","image","image-editor","irc","mirc","mspaint","paint","pixel-art","pixel-editor","terminal","text-art","textual","tui"],"created_at":"2024-08-01T16:01:50.844Z","updated_at":"2025-05-16T04:03:36.897Z","avatar_url":"https://github.com/1j01.png","language":"Python","funding_links":[],"categories":["Python","Community","\u003ca name=\"graphics\"\u003e\u003c/a\u003eGraphics","Table of Contents","Editors, Drawing \u0026 Diagramming","Editors and Tools"],"sub_categories":["Third Party Applications","Imported: Upstream Snippet Gallery","Terminal"],"readme":"\nTextual Paint\n=============\n\nMS Paint in your terminal.\n\nThis is a TUI (Text User Interface) image editor, inspired by MS Paint, built with [Textual](https://textual.textualize.io/).\n\n![MS Paint like interface](https://raw.githubusercontent.com/1j01/textual-paint/v0.1.0/screenshot.svg)\n\n## Features\n\n- [x] Open and save images\n  - [x] Fancy file dialogs\n  - [x] Drag and drop files to open\n  - [x] Warnings when overwriting an existing file, or closing with unsaved changes\n  - [x] Auto-saves a temporary `.ans~` backup file alongside the file you're editing, for crash recovery\n  - [x] Edits ANSI art and raster images and more. See [File Formats](#file-formats)\n- [x] All tools from MS Paint: Free-Form Select, Select, Eraser/Color Eraser, Fill With Color, Pick Color, Magnifier, Pencil, Brush, Airbrush, Text, Line, Curve, Rectangle, Polygon, Ellipse, and Rounded Rectangle\n- [x] Color palette\n- [x] Efficient screen updates and undo/redo history, by tracking regions affected by each action\n- [x] You should be able to use this over SSH\n- [x] Brush previews\n- [x] Status bar\n- [x] Menu bar\n- [x] Keyboard shortcuts\n- [x] Nearly every command from MS Paint is supported, including fun ones like:\n  - [x] Flip/Rotate\n  - [x] Stretch/Skew\n  - [x] Edit Colors\n  - [x] Set As Wallpaper (Tiled/Centered)\n- [x] Localization into 26 languages: Arabic, Czech, Danish, German, Greek, English, Spanish, Finnish, French, Hebrew, Hungarian, Italian, Japanese, Korean, Dutch, Norwegian, Polish, Portuguese, Brazilian Portuguese, Russian, Slovak, Slovenian, Swedish, Turkish, Chinese, Simplified Chinese\n- [x] Dark mode\n- [x] Zooming works with text, despite running in the terminal :)\n\n## Usage\n\nTextual Paint requires a Python version between 3.10 and 3.12 to run.\n\nSee [Compatibility](#compatibility) for details on terminals supported.\n\nPython 3.13 is not yet supported, so please use Python 3.12 for now.\n\n### Installation\n\nUse `pipx` to install globally, without installing dependencies globally:\n```bash\npip install --upgrade pipx  # or in Arch Linux, sudo pacman -S python-pipx\npipx install textual-paint\n```\n\nAlternatively, you can install using `pip`:\n```bash\npip install textual-paint\n```\n\n### Running\n\n```bash\ntextual-paint\n```\n\n### Command Line Options\n\n```\n$ textual-paint --help\nusage: textual-paint [options] [filename]\n\nPaint in the terminal.\n\npositional arguments:\n  filename              Path to a file to open. File will be created if it\n                        doesn't exist.\n\noptions:\n  -h, --help            show this help message and exit\n  --version             show program's version number and exit\n  --theme {light,dark}  Theme to use, either \"light\" or \"dark\"\n  --language {ar,cs,da,de,el,en,es,fi,fr,he,hu,it,ja,ko,nl,no,pl,pt,pt-br,ru,sk,sl,sv,tr,zh,zh-simplified}\n                        Language to use\n  --ascii-only-icons    Use only ASCII characters for tool icons, no emoji or\n                        other Unicode symbols\n  --ascii-only          Use only ASCII characters for the entire UI, for use in\n                        older terminals. Implies --ascii-only-icons\n  --backup-folder FOLDER\n                        Folder to save backups to. By default a backup is saved\n                        alongside the edited file.\n\ndevelopment options:\n  --inspect-layout      Enables DOM inspector (F12) and middle click highlight\n  --clear-screen        Clear the screen before starting, to avoid seeing\n                        outdated errors\n  --restart-on-changes  Restart the app when the source code is changed\n```\n\n### Keyboard Shortcuts\n\n- \u003ckbd\u003eCtrl\u003c/kbd\u003e+\u003ckbd\u003eD\u003c/kbd\u003e: Toggle Dark Mode\n- \u003ckbd\u003eCtrl\u003c/kbd\u003e+\u003ckbd\u003eQ\u003c/kbd\u003e: Quit\n- \u003ckbd\u003eCtrl\u003c/kbd\u003e+\u003ckbd\u003eShift\u003c/kbd\u003e+\u003ckbd\u003eS\u003c/kbd\u003e: Save As **IF SHIFT IS DETECTED** — ⚠️ it might trigger Save instead, and overwrite the open file!\n- \u003ckbd\u003eCtrl\u003c/kbd\u003e+\u003ckbd\u003eShift\u003c/kbd\u003e+\u003ckbd\u003eZ\u003c/kbd\u003e: Redo **IF SHIFT IS DETECTED** — ⚠️ it might trigger Undo instead.\n\nThe rest match MS Paint's keyboard shortcuts:\n\n- \u003ckbd\u003eCtrl\u003c/kbd\u003e+\u003ckbd\u003eS\u003c/kbd\u003e: Save\n- \u003ckbd\u003eCtrl\u003c/kbd\u003e+\u003ckbd\u003eO\u003c/kbd\u003e: Open\n- \u003ckbd\u003eCtrl\u003c/kbd\u003e+\u003ckbd\u003eN\u003c/kbd\u003e: New\n- \u003ckbd\u003eCtrl\u003c/kbd\u003e+\u003ckbd\u003eT\u003c/kbd\u003e: Toggle Tools Box\n- \u003ckbd\u003eCtrl\u003c/kbd\u003e+\u003ckbd\u003eW\u003c/kbd\u003e: Toggle Colors Box\n- \u003ckbd\u003eCtrl\u003c/kbd\u003e+\u003ckbd\u003eZ\u003c/kbd\u003e: Undo\n- \u003ckbd\u003eCtrl\u003c/kbd\u003e+\u003ckbd\u003eY\u003c/kbd\u003e: Redo\n- \u003ckbd\u003eF4\u003c/kbd\u003e: Redo\n- \u003ckbd\u003eCtrl\u003c/kbd\u003e+\u003ckbd\u003eA\u003c/kbd\u003e: Select All\n- \u003ckbd\u003eDelete\u003c/kbd\u003e: Clear Selection\n- \u003ckbd\u003eCtrl\u003c/kbd\u003e+\u003ckbd\u003eC\u003c/kbd\u003e: Copy\n- \u003ckbd\u003eCtrl\u003c/kbd\u003e+\u003ckbd\u003eV\u003c/kbd\u003e: Paste\n- \u003ckbd\u003eCtrl\u003c/kbd\u003e+\u003ckbd\u003eX\u003c/kbd\u003e: Cut\n- \u003ckbd\u003eCtrl\u003c/kbd\u003e+\u003ckbd\u003eE\u003c/kbd\u003e: Image Attributes\n- \u003ckbd\u003eCtrl\u003c/kbd\u003e+\u003ckbd\u003ePageUp\u003c/kbd\u003e: Large Size\n- \u003ckbd\u003eCtrl\u003c/kbd\u003e+\u003ckbd\u003ePageDown\u003c/kbd\u003e: Normal Size\n\n### File Formats\n\n\u003c!-- PyPI doesn't generate linkable headings --\u003e\n\u003ca id=\"file-formats\"\u003e\u003c/a\u003e\n\nMany file formats are supported, including ANSI art, raster images, SVG and HTML.\n\nTo choose a file format when saving, type its file extension. For example, to save a PNG, add `.png` to the end of the filename. The default is `.ans`.\n\n| Format | Notes |\n| --- | --- |\n| **ANSI** (.ans) | Note that while it handles many more ANSI control codes when loading than those that it uses to save files, you may have limited success loading other ANSI files that you find on the web, or create with other tools. ANSI files can vary a lot and even encode animations! |\n| **mIRC codes** (.irc, .mirc) | invented file extensions, and not to be confused with .mrc mIRC script files |\n| **Plain Text** (.txt) | |\n| **SVG** (.svg) | can open SVGs saved by Textual Paint, which embed ANSI data; can also open some other SVGs that consist of a grid of rectangles and text elements. For fun, as a challenge, I made it quite flexible; it can handle uneven grids of unsorted rectangles. But that's only used as a fallback, because it's not perfect. |\n| **HTML** (.htm, html) | write-only (opening not supported) |\n| **PNG** (.png) | opens first frame of an APNG file |\n| **Bitmap** (.bmp) | |\n| **GIF** (.gif) | opens first frame |\n| **TIFF** (.tiff) | opens first frame |\n| **WebP** (.webp) | opens first frame |\n| **JPEG** (.jpg, .jpeg) | saving disabled because it's lossy (it would destroy your pixel art) |\n| **Windows Icon** (.ico) | opens largest size in the file |\n| **Mac OS Icon** (.icns) | opens largest size in the file; saving disabled because it requires specific sizes |\n| **Windows Cursor** (.cur) | opens largest size in the file; saving not supported by Pillow (and it would need a defined hot spot) |\n\nSee [Pillow's documentation](https://pillow.readthedocs.io/en/stable/handbook/image-file-formats.html) for more supported formats.\n\nNote that metadata is not preserved when opening and saving image files. This is however common for many image editors.\n\n### Tips\n\nYou can draw with a character by clicking the selected color display area in the palette and then typing the character,\nor by double clicking the same area to pick a character from a list.\n\nYou can set the text color by right clicking or holding \u003ckbd\u003eCtrl\u003c/kbd\u003e while clicking a color in the palette.\nAlso, if you double right click or hold \u003ckbd\u003eCtrl\u003c/kbd\u003e while double clicking on a color to open the Edit Colors dialog,\nif will edit the text color when you click OK.\n\nYou can swap the foreground and background colors by right clicking or holding \u003ckbd\u003eCtrl\u003c/kbd\u003e while clicking the current colors area.\nThis is a great convenience, especially when using the Color Eraser tool, or when using custom colors that may be hard to distinguish.\n\nYou can display a saved ANSI file in the terminal with `cat`:\n\n```bash\ncat samples/ship.ans\n```\n\nTo browse the sample art, run:\n\n```bash\npython -m src.textual_paint.gallery\n```\n\nTo preview ANSI art files in file managers like Nautilus, Thunar, Nemo, or Caja, you can install the [ansi-art-thumbnailer](https://github.com/1j01/ansi-art-thumbnailer) program I made to go along with this project.\n\n\n## Known Issues\n\n### Editing\n- Undo/Redo doesn't work inside the Text tool's textbox. \u003ckbd\u003eCtrl\u003c/kbd\u003e+\u003ckbd\u003eZ\u003c/kbd\u003e will delete the textbox. (Also note that the Text tool works differently from MS Paint; it will overwrite characters and the cursor can move freely, which makes it better for ASCII art, but worse for prose.)\n- Pressing both mouse buttons stops the current tool, but doesn't undo the current action. Also Pick Color can't be cancelled (with \u003ckbd\u003eEsc\u003c/kbd\u003e or by pressing both mouse buttons), since it samples the color continuously.\n- Airbrush is continuous in space instead of time. It should keep spraying while the mouse stays still.\n- Large files can make the program very slow, as can magnifying the canvas. There is a 500 KB limit when opening files to prevent it from freezing.\n\n### Visual\n- The selection box border appears inside instead of outside (and lacks dashes). For the text box, I hid the border because it was too visually confusing, but it should also have an outer border.\n- The canvas flickers when zooming in with the Magnifier tool.\n- Some languages don't display correctly.\n- The cursor can blink on the canvas while focus is on the character input. In fact you can have three blinking cursors at once if you open the command palette (via the icon in the top left corner) with a cursor on the canvas and focus on the character input.\n\n### Menus\n- Due to limitations of the terminal, shortcuts using \u003ckbd\u003eShift\u003c/kbd\u003e or \u003ckbd\u003eAlt\u003c/kbd\u003e might not work. Menus are not keyboard navigable, because I can't detect \u003ckbd\u003eAlt\u003c/kbd\u003e+\u003ckbd\u003eF\u003c/kbd\u003e, etc.\n- The status bar description can be left blank when selecting a menu item. (I think the `Leave` event can come after closing, once the mouse moves.)\n- Menu items like Copy/Cut/Paste are not grayed out when inapplicable. Only unimplemented items are grayed out.\n- Entering View Bitmap mode with \u003ckbd\u003eCtrl\u003c/kbd\u003e+\u003ckbd\u003eF\u003c/kbd\u003e doesn't close any open menus.\n- \u003ckbd\u003eEsc\u003c/kbd\u003e doesn't close menus.\n\n### File compatibility\n- ANSI files (.ans) are treated as UTF-8 when saving and loading, rather than CP437 or Windows-1252 or any other encodings. Unicode is nice and modern terminals support it, but it's not the standard for ANSI files. There isn't really a standard for ANSI files.\n- ANSI files are loaded with a white background. This may make sense as a default for text files, but ANSI files either draw a background or assume a black background, being designed for terminals.\n- Edit \u003e Paste From doesn't support image files, only ANSI art and plain text files. It should support all the same formats as Open.\n- Error messages may not show up when opening a file fails. I'm not sure how to reproduce this, so if you run into this, do let me know.\n\n### Edit Colors dialog\n- Focus ring shows even while grid is not focused\n- Can show two cells as selected, instead of one across both grids\n- Custom colors order X/Y is different from MS Paint\n- Pressing enter in color grid should select color and close\n- Selection ring is hard to see in dark mode\n- Focus ring is invisible on a black color cell\n- When dragging on the color field or luminosity slider, the cursor can be seen to jump back to earlier places where the mouse was, before settling at the current position. (This may only be visible when the program is running slowly, such as while debugging. I haven't observed this on the canvas, so maybe it has something to do with the dialog being on a separate layer.)\n- When opening the Edit Colors dialog, it may immediately close, if the mouse lines up with the \"OK\" or \"Cancel\" buttons. (This doesn't seem to currently happen, but I haven't knowingly fixed it. A git bisect turned up a bogus commit, possibly due to reproducing the behavior being unreliable. It also seems like it might depend on the specific layout of the dialog, which changed during development, and maybe even the terminal size.)\n\n### Misc\n- Extraneous undo states may be created in some cases. In particular, I noticed when undoing/redoing with free-typing mode, the last state had no cursor but was otherwise identical.\n- Document recovery dialog is shown unnecessarily if the backup file is identical.\n- Pressing a key to exit View Bitmap mode may cause unwanted side effects.\n- Pressing a key doesn't exit View Bitmap mode if the character input is focused.\n\n## Compatibility\n\n\u003c!-- PyPI doesn't generate linkable headings --\u003e\n\u003ca id=\"compatibility\"\u003e\u003c/a\u003e\n\nA Python version between 3.10 and 3.12 is required.\n\n### Linux\n\nTested on Ubuntu 22, with GNOME Terminal, Kitty, XTerm, and VS Code's integrated terminal.\n\nGNOME Terminal works best, with crisp triangles used for icons in dialogs, emoji support, and true color support.\n\nKitty works fine, supporting true color and emoji.\n\nXTerm supports true color, but not emoji. Run with `COLORTERM=truecolor textual-paint --ascii-only` for XTerm compatibility.\n\n### macOS\n\nTested on OSX 10.14 (Mojave), with iTerm2, and VS Code's integrated terminal.\n\nIn VS Code, Free-Form Select shows as tofu (a missing character symbol).\n\nThe default Terminal has missing characters, causing misalignment of everything to the right of them, plus borders are not rendered nicely, giving it a sort of *frayed fabric* look, and it's limited to 256 colors.\n\n### Windows\n\nTextual Paint works with the new [Windows Terminal](https://learn.microsoft.com/windows/terminal/install).\n\n#### Pasting in Windows Terminal\n\n[\u003ckbd\u003eCtrl\u003c/kbd\u003e+\u003ckbd\u003eV\u003c/kbd\u003e does not work](https://github.com/microsoft/terminal/issues/11267) to paste by default, but **Edit \u003e Paste** does work.\nYou can unbind \u003ckbd\u003eCtrl\u003c/kbd\u003e+\u003ckbd\u003eV\u003c/kbd\u003e to fix this:\n- Open Windows Terminal's Settings (\u003ckbd\u003eCtrl\u003c/kbd\u003e+\u003ckbd\u003e,\u003c/kbd\u003e)\n- Click \"Open JSON file\"\n- Disable the paste binding by adding `//` to the beginning of the lines:\n  ```json\n  // {\n  //     \"command\": \"paste\",\n  //     \"keys\": \"ctrl+v\"\n  // },\n  ```\n- Save the file, and the behavior should update immediately.\n\nAlternatively, you can use the Actions tab of the Settings UI to remove the binding for \u003ckbd\u003eCtrl\u003c/kbd\u003e+\u003ckbd\u003eV\u003c/kbd\u003e.\n\nIf you're wondering why *removing* the Paste binding fixes it, it's because Textual Paint needs to receive the literal \u003ckbd\u003eCtrl\u003c/kbd\u003e+\u003ckbd\u003eV\u003c/kbd\u003e key presses in order to trigger its own Paste command.\n\n#### Powershell Problems\n\nRunning in Powershell, you may run into a bug where the powershell prompt becomes active at the same time as the TUI.\nMoving the mouse will redraw parts of the TUI, and it becomes hard to click on things, but still possible.\nCommands can be entered, and the output will be interwoven with the TUI, including if you run a second instance of the program, in which case the two instances will vie for the screen.\nIf this happens, I would recommend first messing around with it, since it's a fun glitch, then opening a new tab in Windows Terminal with the **Command Prompt profile**, available in the new tab dropdown menu.\n\n#### Windows Console\n\nTextual Paint will **not** work properly with the old Windows console (`conhost.exe`), which lacks emoji/Unicode support and true color support.\nThis program is commonly thought of as the \"Command Prompt\", but the Command Prompt (`cmd.exe`) is actually a *shell* (like `bash`) that can run in either the old console or the new Windows Terminal, which are both *terminal emulators*.\n\nYou can run with `--ascii-only` to limit the characters used in the UI to ASCII, but colors will still be limited and similar colors will appear confusingly identical.\n\n### VS Code\n\nNote that VS Code's integrated terminal tries to fix the contrast of text, including in the canvas, which is entirely inappropriate for an ANSI art editor, as it obscures the colors, and can indeed *harm* the contrast of the resulting document, by tricking you into thinking there's more contrast than there actually is.\n\nTo disable this, you can add this to your settings.json:\n\n```json\n\"terminal.integrated.minimumContrastRatio\": 1\n```\n\nIf this doesn't work, try increasing it to 1.1.\n\n\n## Development\n\nFirst, create a virtual environment, and activate it:\n```bash\npython -m venv .venv\n# The activate script is in different places on different systems:\n# Linux/macOS/WSL:\nsource .venv/bin/activate\n# Windows (cmd.exe or PowerShell):\n.venv\\Scripts\\activate\n# Git Bash on Windows:\nsource .venv/Scripts/activate\n```\n\nInstall Textual and other dependencies:\n```bash\npip install -r requirements.txt\n```\n\nRun the app via Textual's CLI for live-reloading CSS support, and enable other development features:\n```bash\ntextual run --dev \"src.textual_paint.paint --clear-screen --inspect-layout --restart-on-changes\"\n```\n\nOr run more basically:\n```bash\npython -m src.textual_paint.paint\n```\n\nOr install the CLI globally\\*:\n```bash\npip install --editable .\n```\n\nThen run:\n```bash\ntextual-paint\n```\n\n\\*If you use a virtual environment, it will only install within that environment.\n\n`--clear-screen` is useful for development, because it's sometimes jarring or perplexing to see error messages that have actually been fixed, when exiting the program.\n\n`--inspect-layout` enables a DOM inspector accessible with F12, which I built. It also lets you apply a rainbow highlight and labels to all ancestors under the mouse with middle click, but this is mostly obsolete/redundant with the DOM inspector now. The labels affect the layout, so you can also hold Ctrl to only colorize, and you can remember how the colors correspond to the labels, to build a mental model of the layout.\n\n`--restart-on-changes` automatically restarts the program when any Python files change. This works by the program restarting itself directly. (Programs like `modd` or `nodemon` that run your program in a subprocess don't work well with a TUI's escape sequences.)\n\nThere are also launch tasks configured for VS Code, so you can run the program from the Run and Debug panel.\nNote that it runs slower in VS Code's debugger.\n\nTo see logs, run [`textual console`](https://textual.textualize.io/guide/devtools/#console) and then run the program via `textual run --dev`.\nThis also makes it run slower.\n\nOften it's useful to exclude events with `textual console -x EVENT`.\n\n### Troubleshooting\n\n\u003e `Unable to import 'app' from module 'src.textual_paint.paint'`\n\n- Make sure to activate the virtual environment, if you're using one.\n- Make sure to run the program from the root directory of the repository.\n\n\u003e `ModuleNotFoundError: No module named 'src'`\n\n- Make sure to run the program from the root directory of the repository.\n\n\u003e `pip install -r requirements.txt` fails with `KeyError: '__version__'` or other errors\n\n- `KeyError: '__version__'` is due to an [incompatibility](https://github.com/python-pillow/Pillow/issues/8075) between Pillow 9.5.0 and Python 3.13. Please use Python 3.12 for now, until I can update Pillow and other dependencies for compatibility with the latest Python version.\n- A VS Code launch configuration is included to debug the installation process.\n  - This allows pausing on exceptions and setting breakpoints in pip source code and `setup.py` files.\n  - If you want to set breakpoints in package source code, or test out modifications to a `setup.py` file, since packages are extracted to temporary folders, you need to pause early and find the newest temporary folder for the package.\n\n### Quality Assurance\n\n```bash\n# Spell checking\n# I use the VS Code extension \"Code Spell Checker\", and its associated CLI:\ncspell-cli lint .\n\n# Type checking\n# I use the \"Python\" and \"Pylance\" VS Code extensions, and the Pyright CLI:\npyright\n# I'm targeting zero errors at this version of Pyright:\nPYRIGHT_PYTHON_FORCE_VERSION=1.1.345 pyright\n# I also tried mypy and fixed some errors it reported, but I'm not targeting zero errors with mypy.\nmypy src --no-namespace-packages --check-untyped-defs\n\n# Visual Regression Testing (and a few other tests)\n# I use pytest-textual-snapshot, which is a pytest plugin for comparing SVG screenshots of Textual apps over time.\npytest\n# To accept differences, update the baseline with:\npytest --snapshot-update\n# I also made a test recorder, which can generate test code, which is great for creating tests that interact with the canvas.\n# Run with:\npython tests/pilot_recorder.py\n# Then interact with the app, and press Ctrl+C to stop recording.\n# You can also hit Ctrl+R to replay what you have,\n# or Ctrl+Z to remove the last step and replay the rest.\n```\n\n### Publishing\n\n- Run QA steps above\n- Update version numbers in `setup.cfg` and `src/textual_paint/__init__.py` to a pre-release version (e.g. `0.3.0-pre.1`)\n- Add version header to `CHANGELOG.md` below \"Unreleased\", and update version links at bottom\n- Commit (e.g. `git commit -m \"Prepare v0.3.0\"`)\n- Build package: `python -m build --sdist --wheel`\n- Upload to TestPyPI: (updating version numbers) `python -m twine upload --repository testpypi dist/textual_paint-0.3.0rc1-py3-none-any.whl dist/textual_paint-0.3.0rc1.tar.gz`\n- Test installing from TestPyPI with: (outside the venv, updating the version number) `pipx uninstall textual-paint; pipx install textual-paint==0.3.0rc1 --pip-args \"--index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple textual-paint\"`\n- If all is good, update version numbers to remove `-pre.N` suffixes\n- Amend commit (`git commit --amend --no-edit`)\n- Rebuild: `python -m build --sdist --wheel`\n- Upload to PyPI: `python -m twine upload dist/textual_paint-0.3.0-py3-none-any.whl dist/textual_paint-0.3.0.tar.gz`\n- Push `main` branch (`git push origin main`)\n- Tag and push tag (e.g. `git tag v0.3.0 \u0026\u0026 git push origin v0.3.0`)\n\n## License\n\n[MIT](https://github.com/1j01/textual-paint/blob/main/LICENSE.txt)\n\n## News\n\nFor a history of changes to the project, see the [changelog](https://github.com/1j01/textual-paint/blob/main/CHANGELOG.md).\n\n## Unicode Symbols and Emojis for Paint Tools\n\nThe first thing I did in this project was to collect possible characters to represent all the tool icons in MS Paint, to gauge how good of a recreation it would be possible to achieve, starting from looks.\nAs it turns out, I didn't run into any significant roadblocks, so I ended up recreating MS Paint. [Again.](https://jspaint.app)\n\nThese are the symbols I've found so far:\n\n- Free-Form Select: ✂️📐🆓🕸✨☆⚝⛤⛥⛦⛧⚛🫥🇫/🇸◌⁛⁘ ⢼⠮ 📿➰➿𓍼യ🪢𓍯 𔗫 𓍲 𓍱 ౿ Ꮼ Ꮘ\n- Select: ✂️⬚▧🔲 ⣏⣹ ⛶\n- Eraser/Color Eraser: 🧼🧽🧹🚫👋🗑️▰▱\n- Fill With Color: 🌊💦💧🩸🌈🎉🎊🪣🫗🚰⛽🍯 ꗃ﹆ ⬙﹅ 🪣﹅\n- Pick Color: 🎨🌈💉💅💧🩸🎈📌📍🪛🪠🥍🩼🌡💄🎯𖡡⤤𝀃🝯⊸⚲𓋼🗡𓍊🍶🧪🍼🌂👁️‍🗨️🧿🍷⤵❣⚗ ⤆Ϸ ⟽þ ⇐ c⟾ /̥͚̥̥͚͚̊̊\n- Magnifier: 🔍🔎👀🔬🔭🧐🕵️‍♂️🕵️‍♀️\n- Pencil: ✏️✎✍️🖎🖊️🖋️✒️🖆📝🖍️🪶🪈🥖🥕▪\n- Brush: 🖌👨‍🎨🧑‍🎨💅🧹🪮🪥🪒🪠ⵄ⑃ሐ⋔⋲ ▭⋹ 𝈸⋹ ⊏⋹ ⸦⋹ ⊂⋹ ▬▤\n- Airbrush: ⛫💨дᖜ💨╔💨🧴🥤🧃🧯🧨🍾🥫💈🫠🌬️🗯☄💭༄༺☁️🌪️🌫🌀🚿 ⪧𖤘 ᗒᗣ дᖜᗕ\n- Text: 📝📄📃📜AＡ🅰️🆎🔤🔠𝐴\n- Line: 📏📉📈＼⟍𝈏╲⧹\\⧵∖\n- Curve: ↪️🪝🌙〰️◡◠~∼≈∽∿〜〰﹋﹏≈≋～⁓\n- Rectangle: ▭▬▮▯➖🟥🟧🟨🟩🟦🟪🟫⬛⬜🔲🔳⏹️◼️◻️◾◽▪️▫️\n- Polygon: ▙𝗟𝙇﹄』𓊋⬣⬟🔶🔷🔸🔹🔺🔻△▲☖⛉♦️🛑📐🪁✴️\n- Ellipse: ⬭⭕🔴🟠🟡🟢🔵🟣🟤⚫⚪🔘🫧🕳️🥚💫💊🛞\n- Rounded Rectangle: ▢⬜⬛𓋰⌨️⏺️💳📺🧫\n\nThe default symbols used may not be the best on your particular system, so I may add some kind of configuration for this in the future.\n\n### Cursor\n\nA crosshair cursor could use one of `+✜✛⊹✚╋╬⁘⁛𖥔⌖⯐`, but it might be better to show the pixel under the cursor, i.e. character cell, surrounded by dashes, like this:\n\n```\n ╻\n╺█╸\n ╹\n```\n\n## See Also\n\n- [JavE](http://jave.de/), an advanced Java-based ASCII art editor\n- [Playscii](http://vectorpoem.com/playscii/), a beautiful ASCII/ANSI art editor. This is also written in Python and MIT licensed, so I might take some code from it, for converting images to ANSI, for example. Who knows, maybe I could even try to support its file format.\n- [cmdpxl](https://github.com/knosmos/cmdpxl), a pixel art editor for the terminal using the keyboard\n- [pypixelart](https://github.com/douglascdev/pypixelart), a pixel art editor using vim-like keybindings, inspired by cmdpxl but not terminal-based\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F1j01%2Ftextual-paint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F1j01%2Ftextual-paint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F1j01%2Ftextual-paint/lists"}