screenman 0.1.0__tar.gz

screenman-0.1.0/.github/workflows/release.yaml

@@ -0,0 +1,125 @@
+# taken from 
+# https://github.com/ArjanCodes/examples/blob/943a877dcea7471a80ab4804018e3a51ca015b9c/2024/publish_pypi/with_trusted_publisher/release_pypi.yaml
+name: release
+
+on:
+  push:
+    tags:
+      - "*-release"
+      - "*-beta"
+      - "[0-9]+.[0-9]+.[0-9]+"
+      - "[0-9]+.[0-9]+.[0-9]+a[0-9]+"
+      - "[0-9]+.[0-9]+.[0-9]+b[0-9]+"
+      - "[0-9]+.[0-9]+.[0-9]+rc[0-9]+"
+
+jobs:
+  details:
+    runs-on: ubuntu-latest
+    outputs:
+      package_name: ${{ steps.package_information.outputs.package_name }}
+      new_version: ${{ steps.release.outputs.new_version }}
+      suffix: ${{ steps.release.outputs.suffix }}
+      tag_name: ${{ steps.release.outputs.tag_name }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Extract tag and Details
+        id: release
+        run: |
+          if [ "${{ github.ref_type }}" = "tag" ]; then
+            TAG_NAME=${GITHUB_REF#refs/tags/}
+            NEW_VERSION=$(echo $TAG_NAME | awk -F'-' '{print $1}')
+            SUFFIX=$(echo $TAG_NAME | awk -F'-' '{print $2}')
+            echo "new_version=$NEW_VERSION" >> "$GITHUB_OUTPUT"
+            echo "suffix=$SUFFIX" >> "$GITHUB_OUTPUT"
+            echo "tag_name=$TAG_NAME" >> "$GITHUB_OUTPUT"
+            echo "Version is $NEW_VERSION"
+            echo "Suffix is $SUFFIX"
+            echo "Tag name is $TAG_NAME"
+          else
+            echo "No tag found"
+            exit 1
+          fi
+
+      - name: "Set up Python"
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: "pyproject.toml"
+
+      - name: Get Name of Package
+        id: package_information
+        run: |
+          PACKAGE_NAME=$(awk -F' = ' '/^name/ {gsub(/"/, "", $2); print $2}' pyproject.toml)
+          echo "Package name: $PACKAGE_NAME"
+          echo "package_name=$PACKAGE_NAME" >> "$GITHUB_OUTPUT"
+
+  check_pypi:
+    needs: details
+    runs-on: ubuntu-latest
+    steps:
+      - name: Fetch information from PyPI
+        run: |
+          PACKAGE_NAME=${{ needs.details.outputs.package_name}}
+          response=$(curl -s https://pypi.org/pypi/$PACKAGE_NAME/json || echo "{}")
+          latest_previous_version=$(echo $response | grep -oP '"releases":\{"\K[^"]+' | sort -rV | head -n 1)
+          if [ -z "$latest_previous_version" ]; then
+            echo "Package not found on PyPI."
+            latest_previous_version="0.0.0"
+          fi
+          echo "Latest version on PyPI: $latest_previous_version"
+          echo "latest_previous_version=$latest_previous_version" >> $GITHUB_ENV
+
+      - name: Compare versions and exit if not newer
+        run: |
+          NEW_VERSION=${{ needs.details.outputs.new_version }}
+          LATEST_VERSION=$latest_previous_version
+          if [ "$(printf '%s\n' "$LATEST_VERSION" "$NEW_VERSION" | sort -rV | head -n 1)" != "$NEW_VERSION" ] || [ "$NEW_VERSION" == "$LATEST_VERSION" ]; then
+            echo "The new version $NEW_VERSION is not greater than the latest version $LATEST_VERSION on PyPI."
+            exit 1
+          else
+            echo "The new version $NEW_VERSION is greater than the latest version $LATEST_VERSION on PyPI."
+          fi
+
+  setup_and_build:
+    needs: details
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: "Set up Python"
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: "pyproject.toml"
+
+      - name: Build source and wheel distribution
+        run: |
+          uv build
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: dist
+          path: dist/
+
+  pypi_publish:
+    name: Upload release to PyPI
+    needs: [setup_and_build, details]
+    runs-on: ubuntu-latest
+    environment:
+      name: release
+    permissions:
+      # In order to use Trusted Publisher
+      id-token: write
+      contents: read
+
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v3
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish distribution to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

screenman-0.1.0/.gitignore

@@ -0,0 +1,106 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# IDE settings
+.vscode/
+.idea/

screenman-0.1.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024, Hendrik Klug
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

screenman-0.1.0/PKG-INFO

@@ -0,0 +1,85 @@
+Metadata-Version: 2.1
+Name: screenman
+Version: 0.1.0
+Summary: A Python tool to manage and configure multi-monitor setups using EDID information, allowing users to apply predefined screen layouts with ease.
+Author-email: Hendrik Klug <hendrik.klug@gmail.com>
+License: MIT license
+Project-URL: Homepage, https://github.com/Jimmy2027/screenman
+Keywords: screenman
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Click>=7.0
+Requires-Dist: loguru>=0.7.2
+Requires-Dist: platformdirs>=4.3.6
+Provides-Extra: test
+Requires-Dist: pytest>=3; extra == "test"
+
+# screenman
+
+A Python tool to manage and configure multi-monitor setups using EDID information, allowing users to apply predefined screen layouts with ease.
+
+## Usage
+
+```terminal
+$ screenman --help
+Usage: screenman [OPTIONS]
+
+  Console script for screenman.
+
+Options:
+  --log-level TEXT  Set the logging level (e.g., DEBUG, INFO, WARNING, ERROR,
+                    CRITICAL)
+  --log-file TEXT   Set the log file path.
+  --print-info      Print the connected screens and the corresponding
+                    layout.If no layout is defined, the default layout 'auto'
+                    is used.
+  --help            Show this message and exit.
+
+```
+
+When wanting to setup a new screen layout, you can use the `--print-info` flag to get the connected screens information. This information can be used to create a new screen layout.
+
+```terminal
+$ screenman --print-info
+<HDMI-2, UID: DL51145435704, primary: True, modes: 13, conn: True, rot: normal, enabled: True, res: (1920, 1080)>
+Layout: auto
+```
+
+From that we can create our toml configuration file with the following content:
+
+```toml
+# the hierarchy of the configuration file is as follows:
+# layouts.<layout_name>.<screen_uid>
+[layouts.single_baetylus.DL51145435704]
+primary = true
+mode = [1920, 1080]
+position = [0, 0]
+rotation = "normal"
+```
+
+A more advanced screenman.toml configuration file can be found in the [examples](examples) directory.
+
+## Installation
+
+### portage
+
+`screenman` is available via [Jimmy's overlay](https://github.com/Jimmy2027/overlay/blob/main/dev-python/screenman/screenman-9999.ebuild).
+Either enable the repo or copy the ebuild to your local overlay.
+
+Then run:
+
+```bash
+emerge -av screenman
+```

screenman-0.1.0/README.md

@@ -0,0 +1,57 @@
+# screenman
+
+A Python tool to manage and configure multi-monitor setups using EDID information, allowing users to apply predefined screen layouts with ease.
+
+## Usage
+
+```terminal
+$ screenman --help
+Usage: screenman [OPTIONS]
+
+  Console script for screenman.
+
+Options:
+  --log-level TEXT  Set the logging level (e.g., DEBUG, INFO, WARNING, ERROR,
+                    CRITICAL)
+  --log-file TEXT   Set the log file path.
+  --print-info      Print the connected screens and the corresponding
+                    layout.If no layout is defined, the default layout 'auto'
+                    is used.
+  --help            Show this message and exit.
+
+```
+
+When wanting to setup a new screen layout, you can use the `--print-info` flag to get the connected screens information. This information can be used to create a new screen layout.
+
+```terminal
+$ screenman --print-info
+<HDMI-2, UID: DL51145435704, primary: True, modes: 13, conn: True, rot: normal, enabled: True, res: (1920, 1080)>
+Layout: auto
+```
+
+From that we can create our toml configuration file with the following content:
+
+```toml
+# the hierarchy of the configuration file is as follows:
+# layouts.<layout_name>.<screen_uid>
+[layouts.single_baetylus.DL51145435704]
+primary = true
+mode = [1920, 1080]
+position = [0, 0]
+rotation = "normal"
+```
+
+A more advanced screenman.toml configuration file can be found in the [examples](examples) directory.
+
+## Installation
+
+### portage
+
+`screenman` is available via [Jimmy's overlay](https://github.com/Jimmy2027/overlay/blob/main/dev-python/screenman/screenman-9999.ebuild).
+Either enable the repo or copy the ebuild to your local overlay.
+
+Then run:
+
+```bash
+emerge -av screenman
+```

screenman-0.1.0/examples/example_screenman.toml

@@ -0,0 +1,48 @@
+[fallback_uid]
+frametux = { Manufacturer = "BOE", Model = "3018" }
+
+[layouts.office.008NTLE9T528]
+# horizontal screen
+primary = true
+mode = [2560, 1440]
+position = [0, 0]
+rotation = "left"
+
+[layouts.office.H4ZRA04684]
+# vertical screen
+primary = false
+mode = [3440, 1440]
+position = [1440, 0]
+rotation = "normal"
+
+[layouts.office.frametux]
+enabled = false
+primary = false
+mode = [2256, 1504]
+position = [0, 0]
+rotation = "normal"
+
+[layouts.single_frametux.frametux]
+primary = true
+mode = [2256, 1504]
+position = [0, 0]
+rotation = "normal"
+
+[layouts.single_baetylus.DL51145435704]
+primary = true
+mode = [1920, 1080]
+position = [0, 0]
+rotation = "normal"
+
+[layouts.home.frametux]
+enabled = true
+primary = true
+mode = [2256, 1504]
+position = [0, 0]
+rotation = "normal"
+
+[layouts.home.DL51145435704]
+primary = false
+mode = [1920, 1080]
+position = [2256, 0]
+rotation = "normal"

screenman-0.1.0/pyproject.toml

@@ -0,0 +1,39 @@
+[build-system]
+build-backend = "setuptools.build_meta"
+requires = [
+    "setuptools>=61",
+    "setuptools-scm[toml]>=6.2.3",
+]
+
+[project]
+name = "screenman"
+version = "0.1.0"
+description = "A Python tool to manage and configure multi-monitor setups using EDID information, allowing users to apply predefined screen layouts with ease."
+readme = "README.md"
+license = { text = "MIT license" }
+authors = [{ name = "Hendrik Klug", email = "hendrik.klug@gmail.com" }]
+keywords = ["screenman"]
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.6",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+dependencies = ["Click>=7.0", "loguru>=0.7.2", "platformdirs>=4.3.6"]
+requires-python = ">=3.9"
+
+[project.urls]
+Homepage = "https://github.com/Jimmy2027/screenman"
+
+[project.scripts]
+screenman = "screenman.cli:main"
+
+[project.optional-dependencies]
+test = ["pytest>=3"]

screenman-0.1.0/screenman/__init__.py

@@ -0,0 +1,10 @@
+"""Top-level package for screenman."""
+
+__author__ = """Hendrik Klug"""
+__email__ = "hendrik.klug@gmail.com"
+__version__ = "0.1.0"
+
+from screenman.config import Config
+
+# Load the configuration
+toml_config = Config.load_from_toml()

screenman-0.1.0/screenman/cli.py

@@ -0,0 +1,52 @@
+"""Console script for screenman."""
+
+import sys
+
+import click
+from loguru import logger
+
+from screenman.screen import apply_layout, connected_screens, determine_layout
+
+
+def configure_logger(log_level="INFO", log_file=None):
+    logger.remove()  # Remove default logger
+    logger.add(sys.stderr, level=log_level)  # Add stderr logging with chosen level
+
+    if log_file:
+        logger.add(log_file, rotation="1 MB", retention="10 days", level=log_level)
+
+
+@click.command()
+@click.option(
+    "--log-level",
+    default="INFO",
+    help="Set the logging level (e.g., DEBUG, INFO, WARNING, ERROR, CRITICAL)",
+)
+@click.option("--log-file", default=None, help="Set the log file path.")
+@click.option(
+    "--print-info",
+    is_flag=True,
+    help="Print the connected screens and the corresponding layout."
+    "If no layout is defined, the default layout 'auto' is used.",
+)
+def main(log_level, log_file, print_info):
+    """Console script for screenman."""
+    configure_logger(log_level, log_file)
+
+    screens = connected_screens()
+    layout_name = determine_layout(screens)
+    if print_info:
+        for s in screens:
+            print(s)
+        print(f"Layout: {layout_name}")
+        return
+
+    if layout_name:
+        logger.info(f"Applying layout: {layout_name}")
+        apply_layout(screens, layout_name)
+    else:
+        logger.info("No matching layout found.")
+
+
+if __name__ == "__main__":
+    sys.exit(main())  # pragma: no cover

screenman-0.1.0/screenman/config.py

@@ -0,0 +1,65 @@
+from screenman.utils import ScreenSettings
+
+
+from platformdirs import site_config_dir, user_config_dir
+
+
+import tomllib
+from dataclasses import dataclass, field
+from pathlib import Path
+from typing import Dict
+
+from screenman.utils import str_to_rot
+
+
+@dataclass
+class Config:
+    # for some reason, some monitors don't include the serial number in the EDID
+    # for those, define some fallback option to which the edid is matched.
+    # This will not be a unique identifier, so it will not work if you have multiple monitors of the same model
+    fallback_uid: Dict[str, Dict[str, str]] = field(default_factory=dict)
+    layouts: Dict[str, Dict[str, ScreenSettings]] = field(default_factory=dict)
+
+    @classmethod
+    def load_from_toml(cls) -> "Config":
+        config_paths = [
+            Path.cwd(),
+            Path.home(),
+            Path(user_config_dir(roaming=True)),
+            Path(user_config_dir("synthara_sdk", roaming=False)),
+            Path(site_config_dir()),
+        ]
+        for path in config_paths:
+            path = path / "screenman.toml"
+            if path and path.exists():
+                try:
+                    with open(path, "rb") as f:
+                        config_data = tomllib.load(f)
+                    fallback_uid = config_data.get("fallback_uid", {})
+                    layouts = {
+                        layout_name: {
+                            screen_name: ScreenSettings(
+                                resolution=tuple(screen_data.get("mode", (0, 0))),
+                                is_primary=screen_data.get("primary", False),
+                                is_enabled=screen_data.get("enabled", True),
+                                rotation=str_to_rot(
+                                    screen_data.get("rotation", "normal")
+                                ),
+                                position=(
+                                    "--pos",
+                                    f"{screen_data['position'][0]}x{screen_data['position'][1]}",
+                                )
+                                if "position" in screen_data
+                                else None,
+                            )
+                            for screen_name, screen_data in layout_screens.items()
+                        }
+                        for layout_name, layout_screens in config_data.get(
+                            "layouts", {}
+                        ).items()
+                    }
+                    return cls(fallback_uid=fallback_uid, layouts=layouts)
+                except Exception as e:
+                    print(f"Failed to load configuration file '{path}': {e}")
+        # Default configuration if no config file is found
+        return cls()