Skip to content

Commit 933d919

Browse files
author
BoboTiG
committed
First commit: add .gitignore and update README
1 parent f1b77b6 commit 933d919

2 files changed

Lines changed: 50 additions & 3 deletions

File tree

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
src/
2+
tests/
3+
support.html

README.md

Lines changed: 47 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,48 @@
1-
python-mss
2-
==========
1+
Python MSS
2+
===
3+
4+
An attempt to create a full functionnal cross-platform multi-screen
5+
shot module in _pure_ python using ctypes.
6+
7+
Very basic, it will grab one screen shot by monitor or a screen shot
8+
of all monitors and save it to an optimised/progressive JPEG file.
9+
10+
MSS is for *Multi-Screen Shot*.
11+
12+
Dependancies & requirements
13+
---
14+
15+
Python. And that is all :)
16+
MSS is writen in pure python, it uses ctypes.
17+
ctypes has been introduced in Python 2.5, before it will need ctypes modules to be installed separately.
18+
19+
Support
20+
---
21+
22+
You can see the support table [here](https://tiger-222.fr/tout/python-mss/support.html).
23+
Feel free to try MSS on a system we had not tested, and let report us by creating an [issue](https://github.com/BoboTiG/python-mss/issues).
24+
25+
Usage
26+
---
27+
28+
It is quite easy, just call a new instance of `MSS()` and then `save()`.
29+
You can pass `oneshot=True` to create one screen shot of all monitors.
30+
31+
from mss import MSS
32+
try:
33+
mss = MSS()
34+
# One shot per monitor
35+
for filename in mss.save():
36+
print('File "{0}" created.').format(filename)
37+
# A shot to grab them all :)
38+
filename = mss.save(oneshot=True)[0]
39+
print('[Full] File "{0}" created.').format(filename)
40+
except Exception as ex:
41+
print(ex)
42+
43+
Bonus
44+
---
45+
46+
Just for fun ...
47+
Show us your screen shot with all monitors in one file, we will update the [gallery](https://tiger-222.fr/tout/python-mss/galerie/) ;)
348

4-
Multi-Screen Shot: cross-plateform Python module using only pure python (ctypes) to grab screen shot. Created with the goal to support multi-screen and be light.

0 commit comments

Comments
 (0)