{"id":28714647,"url":"https://github.com/rsusik/screenpen","last_synced_at":"2025-06-15T01:08:23.291Z","repository":{"id":51819299,"uuid":"354654760","full_name":"rsusik/screenpen","owner":"rsusik","description":"ScreenPen is a simple screen annotation software that allows drawing directly on the screen.","archived":false,"fork":false,"pushed_at":"2025-01-12T15:26:22.000Z","size":20882,"stargazers_count":110,"open_issues_count":2,"forks_count":22,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-05-20T19:19:53.192Z","etag":null,"topics":["annotation","desktop","draw","drawing","epic","epic-pen-alternative","epicpen","epicpen-alternative","marker","mouse","paint","pen","presentation","remote","screen","screen-annotation","screen-capture","screen-marker","tool"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rsusik.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2021-04-04T21:59:13.000Z","updated_at":"2025-05-12T15:14:28.000Z","dependencies_parsed_at":"2023-10-04T15:12:56.191Z","dependency_job_id":"273120dd-6fc8-4f9b-86d6-b4d9bca1b7ec","html_url":"https://github.com/rsusik/screenpen","commit_stats":{"total_commits":64,"total_committers":2,"mean_commits":32.0,"dds":0.03125,"last_synced_commit":"53f2a9d98a1aff0bf9d332f56093e7a3ca38cb1b"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/rsusik/screenpen","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rsusik%2Fscreenpen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rsusik%2Fscreenpen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rsusik%2Fscreenpen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rsusik%2Fscreenpen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rsusik","download_url":"https://codeload.github.com/rsusik/screenpen/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rsusik%2Fscreenpen/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259906193,"owners_count":22929978,"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":["annotation","desktop","draw","drawing","epic","epic-pen-alternative","epicpen","epicpen-alternative","marker","mouse","paint","pen","presentation","remote","screen","screen-annotation","screen-capture","screen-marker","tool"],"created_at":"2025-06-15T01:08:06.539Z","updated_at":"2025-06-15T01:08:23.271Z","avatar_url":"https://github.com/rsusik.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://github.com/rsusik/screenpen/raw/master/screenpen.png\" alt=\"ScreenPen\" /\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n    \u003cem\u003eMultiplatform screen annotation software that allows drawing directly on the screen.\u003c/em\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://pypi.org/project/screenpen\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://img.shields.io/pypi/v/screenpen?color=%2334D058\u0026label=pypi%20package\" alt=\"Package version\"\u003e\n\u003c/a\u003e\n\u003ca href=\"https://github.com/rsusik/screenpen/blob/master/LICENSE\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/license/rsusik/screenpen\" alt=\"License\"\u003e\n\u003c/a\u003e\n\u003ca href=\"https://pepy.tech/project/screenpen\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://static.pepy.tech/personalized-badge/screenpen?period=total\u0026units=international_system\u0026left_color=grey\u0026right_color=brightgreen\u0026left_text=Downloads\" alt=\"Number of downloads\"\u003e\n\u003c/a\u003e\n\u003ca href=\"https://pepy.tech/project/screenpen\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://static.pepy.tech/personalized-badge/screenpen?period=month\u0026units=international_system\u0026left_color=grey\u0026right_color=brightgreen\u0026left_text=Downloads/month\"\u003e\n\u003c/a\u003e\n\u003c/p\u003e\n\n\n## Description\n\nScreen annotation software which allows drawing directly on the screen. \nIt is an open source and multiplatform \n(all systems that support Python) \nalternative to tools such as Epic Pen. \nSupported shapes:\n* line,\n* rectangle,\n* chart (using matplotlib).\n\nThe behavior of the program depends on the Window System you use:\n* if the system supports \"live transparency then a transparent background is used (you can see a video playing in the background),\n* if not then the screenshot is taken, and the user draws on the captured image (you see a static image of the screen),\n* sometimes your WM may be detected as not supporting \"live transparency\". In that case try running with `-t` parameter to force it._\n\n\n### Demo (video)\n\nhttps://user-images.githubusercontent.com/19404835/130215780-705e4eb9-330b-4a91-bd1f-b9ec3843556e.mp4\n\n\n*Note: The app is created ad-hoc only for my use case. It may contain bugs...*\n\n\n## Usage\n\n### Installation and execution\n\nTu run the program you need to have Python installed and execute following:\n\n```bash\npip install screenpen\nscreenpen                # or python -m screenpen\n```\n\n**NOTE: Your WM may be detected as not supporting \"live transparency\". In that case try running with `-t` parameter:**\n\n```bash\nscreenpen -t\n```\n\n### Controls\n* Left mouse button - drawing.\n* Right mouse button - quit.\n* Keyboard shortcuts:\n    * `Ctrl+Z` - undo,\n    * `Ctrl+Y` - redo,\n    * hold `Shift` - change mouse cursor icon to arrrow.\n\n\n### Configuration\nThere are a few configuration options that can be set using config file:\n* `icon_size` - size of the icons (default: 50)\n* `hidden_menus` - to hide menus on start (default: False)\n\nThe config should look like below:\n```ini\n[screenpen]\n; Possible values for areas: topToolBarArea, bottomToolBarArea, leftToolBarArea, rightToolBarArea\npenbar_area = topToolBarArea\nboardbar_area = topToolBarArea\nactionbar_area = leftToolBarArea\nhidden_menus = False\nicon_size = 50\nsc_undo = Ctrl+Z\nsc_redo = Ctrl+Y\nsc_toggle_menus = Ctrl+1\nexit_mouse_button = right\nexit_shortcut = Escape\ndrawing_history = 500\n```\n(more options will be added in the future...)\n\n### TODO\n\n- [ ] Better Matplotlib charts support.\n- [ ] Better wayland support.\n- [ ] Add \"paste image\" feature.\n- [ ] Add ellipse shape.\n- [ ] Keyboard shortcuts for changing colors.\n\n### Compatilibity notes\n\nScreenpen (from 0.2 version) is compatible with PyQt5 and PyQt6, nevertheless the PyQt5 is currently in the requirements and recommended.\nIt is possible to run it using PyQt6 by running:\n```\npip install matplotlib\u003e=3.2 numpy\u003e=1.8 PyQt6\npip install screenpen --no-deps\n```\n\n### Wayland support\n\nScreenpen works in some Wayland compositors, but it is not perfect.\nThere are issues with windows positioning and transparency.\nIn case the window opens on wrong monitor (which I noticed on Sway WM) you can move it using `Win+Shift+Arrows` (or `Alt+Shift+Arrows`) shortcuts to a desired monitor.\nI have no plans to fix it in near future, but I will accept PRs.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frsusik%2Fscreenpen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frsusik%2Fscreenpen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frsusik%2Fscreenpen/lists"}