Metadata-Version: 2.1
Name: screenpen
Version: 0.1.5
Summary: Screen annotation software which allows drawing directly on the screen.
Home-page: https://rsusik.github.io/screenpen/
Author: Robert Susik
Author-email: robert.susik@gmail.com
License: GPLv3
Platform: UNKNOWN
Classifier: Environment :: X11 Applications :: Qt
Classifier: Framework :: Matplotlib
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Communications :: Conferencing
Classifier: Topic :: Education
Classifier: Topic :: Multimedia :: Graphics :: Capture :: Screen Capture
Classifier: Topic :: Multimedia :: Graphics :: Presentation
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: PyQt5
Requires-Dist: matplotlib (==3.2)
Requires-Dist: numpy

# ScreenPen

## Description

Screen annotation software which allows drawing directly on the screen. It is a free and multiplatform (all systems that support Python) alternative for tools such as Epic Pen. Supported shapes:
* line,
* rectangle,
* chart (using matplotlib).

The behavior of he programs depends on the OS you use:
* For Linux transparent background is used (you can see a video playing in the background).
* For Windows, the screenshot is taken, and the user draws on the captured image (you see a static image of the screen).

### Controls
* Left mouse button - drawing.
* Right mouse button - quit.
* Keyboard shortcuts:
    * `Ctrl+Z` - undo,
    * `Ctrl+Y` - redo,
    * hold `Shift` - change mouse cursor icon to arrrow.

### Demo (video)

https://user-images.githubusercontent.com/19404835/116938635-5e63a980-ac6b-11eb-818d-7723967e1d94.mp4?s=100


*Note: The app is created ad-hoc only for my use case. It may contain bugs, and the code definitely is not clean.*


## Usage

Tu run the program:

### Pip

```bash
pip install -r requirements.txt
python screenpen.pyw
```

### Conda

Once virtual env is activated:
```bash
conda install --file requirements.txt
python screenpen.pyw
```


