Initial source

Author: danny-burrows

README.md

@@ -1,2 +1,48 @@
-# rotate-screen
+# Rotate Screen
 A small Python package for rotating the screen.
+
+## Platforms Supported
+Windows is currently the only platform supported.
+
+## Installation
+Clone the repo or download as zip then navigate to the project root directory and use the following command...
+```sh
+pip install .
+```
+
+## Example: ![Ctrl+Alt+Arrow Shortcut](https://github.com/TheBrokenEstate/rotate-screen/examples/shortcut.py)
+This is a simple example that implements the 'Ctrl+Alt+Arrow' shortcut for rotating the display. Some graphics cards don't come with this capability by default.
+
+This example requires the keyboard module...
+```sh
+pip install keyboard
+```
+Here is the code! This module adds hotkeys to rotate the main display to the corresponding arrow keys.
+```python
+import rotatescreen
+import keyboard
+
+screen = rotatescreen.get_primary_display()
+
+keyboard.add_hotkey('ctrl+alt+up', screen.set_landscape, suppress=True)
+keyboard.add_hotkey('ctrl+alt+right', screen.set_portrait_flipped, suppress=True)
+keyboard.add_hotkey('ctrl+alt+down', screen.set_landscape_flipped, suppress=True)
+keyboard.add_hotkey('ctrl+alt+left', screen.set_portrait, suppress=True)
+
+keyboard.wait()
+```
+
+## Example: ![Do A Barrel Roll](https://github.com/TheBrokenEstate/rotate-screen/examples/do-a-barrel-roll.py)
+This was a little joke script to show off some more of the modules functionality, due to the way windows rotates the display this is a pretty horrific looking, but entertaining. :)
+```python
+import rotatescreen
+import time
+
+screen = rotatescreen.get_primary_display()
+start_pos = screen.current_orientation
+
+for i in range(1, 5):
+    pos = abs((start_pos - i*90) % 360)
+    screen.rotate_to(pos)
+    time.sleep(1.5)
+```

examples/do-a-barrel-roll.py

@@ -0,0 +1,10 @@
+import rotatescreen
+import time
+
+screen = rotatescreen.get_primary_display()
+start_pos = screen.current_orientation
+
+for i in range(1, 5):
+    pos = abs((start_pos - i*90) % 360)
+    screen.rotate_to(pos)
+    time.sleep(1.5)

examples/shortcuts.py

@@ -0,0 +1,11 @@
+import rotatescreen
+import keyboard
+
+screen = rotatescreen.get_primary_display()
+
+keyboard.add_hotkey('ctrl+alt+up', screen.set_landscape, suppress=True)
+keyboard.add_hotkey('ctrl+alt+right', screen.set_portrait_flipped, suppress=True)
+keyboard.add_hotkey('ctrl+alt+down', screen.set_landscape_flipped, suppress=True)
+keyboard.add_hotkey('ctrl+alt+left', screen.set_portrait, suppress=True)
+
+keyboard.wait()

rotatescreen/__init__.py

@@ -0,0 +1 @@
+from .display import *

rotatescreen/display.py

@@ -0,0 +1,84 @@
+import win32api
+import win32con
+
+
+def get_displays():
+    displays = [Display(hMonitor) for hMonitor,_,_ in win32api.EnumDisplayMonitors()]
+    return displays
+
+
+def get_primary_display():
+    for display in get_displays():
+        if display.is_primary:
+            return display
+
+
+def get_secondary_displays():
+    displays = [display for display in get_displays() if not display.is_primary]
+    return displays
+
+
+class Display:
+
+    def __init__(self, hMonitor):
+        self.hMonitor = hMonitor
+
+    def __repr__(self):
+        return f"<'{self.device_description[0]}' object>"
+
+    def rotate_to(self, degrees):
+        if degrees == 90:
+            rotation_val = win32con.DMDO_90
+        elif degrees == 180:
+            rotation_val = win32con.DMDO_180
+        elif degrees == 270:
+            rotation_val = win32con.DMDO_270
+        elif degrees == 0:
+            rotation_val = win32con.DMDO_DEFAULT
+        else:
+            raise ValueError("Display can only be rotated to 0, 90, 180, or 270 degrees.")
+
+        dm = self.devicemodeW
+        if((dm.DisplayOrientation + rotation_val) % 2 == 1):
+            dm.PelsWidth, dm.PelsHeight = dm.PelsHeight, dm.PelsWidth
+        dm.DisplayOrientation = rotation_val
+        win32api.ChangeDisplaySettingsEx(self.device, dm)
+
+    def set_landscape(self):
+        self.rotate_to(0)
+
+    def set_landscape_flipped(self):
+        self.rotate_to(180)
+
+    def set_portrait(self):
+        self.rotate_to(90)
+
+    def set_portrait_flipped(self):
+        self.rotate_to(270)
+
+    @property
+    def current_orientation(self):
+        state = self.devicemodeW.DisplayOrientation
+        return state * 90
+
+    @property
+    def info(self):
+        return win32api.GetMonitorInfo(self.hMonitor)
+
+    @property
+    def device(self):
+        return self.info["Device"]
+
+    @property
+    def is_primary(self):
+        # The only flag is MONITORINFOF_PRIMARY which is 1 only for the primary monitor.
+        return self.info["Flags"]
+
+    @property
+    def device_description(self):
+        display_device = win32api.EnumDisplayDevices(self.device)
+        return display_device.DeviceString, display_device.DeviceID
+
+    @property
+    def devicemodeW(self):
+        return win32api.EnumDisplaySettings(self.device, win32con.ENUM_CURRENT_SETTINGS)

setup.py

@@ -0,0 +1,48 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import os
+from setuptools import find_packages, setup, Command
+
+NAME = 'rotate-screen'
+DESCRIPTION = 'A small Python package for rotating the screen.'
+URL = 'https://github.com/TheBrokenEstate/rotate-screen'
+EMAIL = '[email protected]'
+AUTHOR = 'Dan Burrows'
+REQUIRES_PYTHON = '>=3.6.0'
+VERSION = '0.1.0'
+
+# Optional package for the examples...
+EXTRAS = {
+    'shortcuts_example': ['keyboard']
+}
+
+here = os.path.abspath(os.path.dirname(__file__))
+with open(os.path.join(here, 'README.md'), encoding='utf-8') as f:
+    long_description = f.read()
+
+setup(
+    name=NAME,
+    version=VERSION,
+    description=DESCRIPTION,
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    author=AUTHOR,
+    author_email=EMAIL,
+    python_requires=REQUIRES_PYTHON,
+    url=URL,
+    packages=find_packages(exclude=["tests", "*.tests", "*.tests.*", "tests.*"]),
+    extras_require=EXTRAS,
+    license='MIT',
+    classifiers=[
+        'License :: OSI Approved :: MIT License',
+        'Operating System :: Microsoft :: Windows',
+        'Topic :: Desktop Environment',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3 :: Only',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8'
+    ]
+)