Add pip setup, ready to use 'pip install mss'

BoboTiG · BoboTiG · commit def445f35368 · 2013-10-21T19:43:24.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -1 +1,3 @@
+*.pyc
 tests/
+MANIFEST.in
diff --git a/README.md b/README.md
diff --git a/README.rst b/README.rst
@@ -0,0 +1,94 @@
+**********************************************************************
+A cross-platform multi-screen shot module in pure python using ctypes
+**********************************************************************
+
+Very basic, it will grab one screen shot by monitor or a screen shot of all monitors and save it to an optimised/progressive PNG/JPEG file, Python 2.7/3.3 compatible.
+
+So, while you can `pip install mss`, you may just drop it in your project and forget about it.
+
+MSS stands for Multi-Screen Shot.
+
+It's under zlib licence.
+
+
+Instance the good class
+========================
+
+You can determine automatically which class to use::
+
+    from platform import system
+    from mss import *
+
+    systems = {
+        'Darwin' : MSSMac,
+        'Linux'  : MSSLinux,
+        'Windows': MSSWindows
+    }
+    try:
+        MSS = systems[system()]
+    except KeyError:
+        err = 'System "{0}" not implemented.'.format(system())
+        raise NotImplementedError(err)
+
+Or simply import the good one::
+
+    from mss import MSSLinux as MSS
+
+
+init(debug=False)
+-----------------
+
+When initalising an instance of MSS, you can enable debug output::
+
+    mss = MSS(debug=True)
+
+
+save(output='mss', oneshot=False, ext='png', ftype=0)
+-----------------------------------------------------
+
+For each monitor, grab a screen shot and save it to a file.
+
+Parameters::
+
+    output - string - the output filename without extension
+    oneshot - boolean - grab only one screen shot of all monitors
+    ext - string - file format to save
+    ftype - int - PNG filter type (0..4 [slower])
+
+This is a generator which returns created files::
+
+    'output-1.ext',
+    'output-2.ext',
+    ...,
+    'output-NN.ext'
+    or
+    'output-full.ext'
+
+
+Example
+========
+
+Then, it is quite simple::
+
+    try:
+        mss = MSS()
+
+        # One screen shot per monitor
+        for filename in mss.save():
+            print('File "{0}" created.'.format(filename))
+
+        # A shot to grab them all :)
+        for filename in mss.save(oneshot=True):
+            print('File "{0}" created.'.format(filename))
+    except Exception as ex:
+        print(ex)
+        raise
+
+
+Bonus
+======
+
+Just for fun ...
+Show us your screen shot with all monitors in one file, we will update the gallery.
+
+Link to the galley: https://tiger-222.fr/tout/python-mss/galerie/
diff --git a/mss.py b/mss.py
@@ -1,8 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
-''' An attempt to create a full functionnal multi-screen shot module
-    in _pure_ python using ctypes.
+''' A cross-platform multi-screen shot module in pure python using ctypes.
 
     This module is maintained by Mickaël Schoentgen <contact@tiger-222.fr>.
     If you find problems, please submit bug reports/patches via the
@@ -202,7 +201,7 @@ def save(self, output='mss', oneshot=False, ext='png', ftype=0):
 
             Parameters:
              - output - string - the output filename without extension
-             - oneshot - boolean -grab only one screen shot of all monitors
+             - oneshot - boolean - grab only one screen shot of all monitors
              - ext - string - file format to save
              - ftype - int - PNG filter type (0..4 [slower])
 
diff --git a/setup.py b/setup.py
@@ -0,0 +1,34 @@
+
+try:
+    from distutils.core import setup
+except ImportError:
+    from setuptools import setup
+
+open('MANIFEST.in', 'w').write('\n'.join((
+    "include *.rst",
+)))
+
+from mss import __version__
+
+setup(
+
+    name="mss",
+    version=__version__,
+    author="Tiger-222",
+    py_modules=['MSS'],
+    author_email="contact@tiger-222.fr",
+    description="A cross-platform multi-screen shot module in pure python using ctypes.",
+    long_description=open('README.rst').read(),
+    classifiers=[
+        'Programming Language :: Python',
+        "Intended Audience :: Developers",
+        "Intended Audience :: Information Technology",
+        "License :: OSI Approved :: zlib/libpng License",
+        "Natural Language :: English",
+        "Programming Language :: Python :: 2.7",
+        "Programming Language :: Python :: 3.3",
+        "Topic :: Multimedia :: Graphics :: Capture :: Screen Capture",
+    ],
+    url="https://github.com/BoboTiG/python-mss"
+)
+
