Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexdelorenzo/screenshot
📸 Automate capturing screenshots of apps and windows on macOS
https://github.com/alexdelorenzo/screenshot
automated capture mac macos macosx osx quartz screencapture screenshot screenshots
Last synced: about 1 month ago
JSON representation
📸 Automate capturing screenshots of apps and windows on macOS
- Host: GitHub
- URL: https://github.com/alexdelorenzo/screenshot
- Owner: alexdelorenzo
- License: agpl-3.0
- Created: 2015-03-08T18:46:33.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2021-08-24T01:43:48.000Z (about 3 years ago)
- Last Synced: 2024-07-12T20:58:11.030Z (2 months ago)
- Topics: automated, capture, mac, macos, macosx, osx, quartz, screencapture, screenshot, screenshots
- Language: Python
- Homepage: https://alexdelorenzo.dev
- Size: 51.8 KB
- Stars: 172
- Watchers: 4
- Forks: 13
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 📸 screenshot: Better macOS screenshots via the Terminal
`screenshot` is a command line utility that lets you specify an *application name* and *window title* in order to take a screenshot of a specific window.
Using `screenshot`, you can capture windows belonging to an application, or only an application's windows with certain titles.
## Justification and Use Case
The macOS `screencapture` utility is not developer friendly.
To programmatically take a screenshot of an application, or a specific window, you must supply a *window ID* to `screencapture`.
In order to find a window's *window ID*, you'll need call out to Quartz.
In newer versions of macOS, the `screencapture` utility improves the user experience slightly: you can run the command and then click on the window you'd like to capture.
However, that necessitates that the user clicks a window each time. You cannot include this as part of an automated pipeline.
To that end, I use this utility to automatically generate screenshots of web, mobile and desktop applications.
## Example
Take a screenshot of the current Terminal window and view it with Preview.app:
```bash
open "`screenshot Terminal`"
```
Take a screenshot of the Pycharm application with the *window title* containing "screenshot":
```bash
screenshot Pycharm -t screenshot
```
## Installation
You will need Python 3.6+. Please install it with `brew` or `ports` if you do not have it already.
### PyPI
```bash
pip3 install screenshot
```
### Github Source
Grab the source, run the following in the source dir:
```bash
pip3 install -r requirements.txt
```
then run
```bash
python3 setup.py install
```
## Usage
`screenshot --help`
```
Usage: screenshot [OPTIONS] APPLICATION_NAME
Options:
-w, --window_selection_options TEXT
Options: all_windows, on_screen_only,
above_window, below_window, include_window,
exclude_desktop
Default: exclude_desktop
on_screen_only
-t, --title TEXT Title of window from APPLICATION_NAME to
capture.
-f, --filename TEXT Filename to save the captured PNG as.
-a, --all_windows Capture all windows matching parameters.
-o, --output TEXT Image format to create, default is png
(other options include pdf, jpg, tiff)
-s, --shadow Capture the shadow of the window.
--help Show this message and exit.
```
## License
See `LICENSE`. Message me if you'd like to use this project with a different license.