From 75e12eb68e61692d91d56edf49874f43ebe19320 Mon Sep 17 00:00:00 2001 From: Kieran W <41634689+FredHappyface@users.noreply.github.com> Date: Sat, 20 Jan 2024 17:37:21 +0000 Subject: [PATCH] rel 2024.1 --- documentation/reference/getostheme/index.md | 61 ++++++++++---------- documentation/reference/getostheme/module.md | 4 +- pyproject.toml | 5 +- requirements.txt | 1 + 4 files changed, 37 insertions(+), 34 deletions(-) diff --git a/documentation/reference/getostheme/index.md b/documentation/reference/getostheme/index.md index 728a75f..e8ba784 100644 --- a/documentation/reference/getostheme/index.md +++ b/documentation/reference/getostheme/index.md @@ -1,7 +1,6 @@ # Getostheme -[Getostheme Index](../README.md#getostheme-index) / -Getostheme +[Getostheme Index](../README.md#getostheme-index) / Getostheme > Auto-generated documentation for [getostheme](../../../getostheme/__init__.py) module. @@ -16,25 +15,27 @@ Getostheme ## cli -[Show source in __init__.py:153](../../../getostheme/__init__.py#L153) +[Show source in __init__.py:161](../../../getostheme/__init__.py#L161) -CLI entry point +CLI entry point. #### Signature ```python -def cli(): ... +def cli() -> None: ... ``` ## isDarkMode -[Show source in __init__.py:145](../../../getostheme/__init__.py#L145) +[Show source in __init__.py:151](../../../getostheme/__init__.py#L151) -#### Returns +Is the OS in dark mode?. -- `bool` - OS is in dark mode +Returns +------- + bool: OS is in dark mode #### Signature @@ -46,13 +47,13 @@ def isDarkMode() -> bool: ... ## isLightMode -[Show source in __init__.py:130](../../../getostheme/__init__.py#L130) +[Show source in __init__.py:135](../../../getostheme/__init__.py#L135) -Call isLightMode_OS +Call isLightMode_OS. -#### Returns - -- `bool` - OS is in light mode +Returns +------- + bool: OS is in light mode #### Signature @@ -64,13 +65,13 @@ def isLightMode() -> bool: ... ## isLightMode_Linux -[Show source in __init__.py:107](../../../getostheme/__init__.py#L107) - -For Linux OS MIT FredHappyface +[Show source in __init__.py:111](../../../getostheme/__init__.py#L111) -#### Returns +For Linux OS MIT FredHappyface. -- `bool` - Linux is in light mode +Returns +------- + bool: Linux is in light mode #### Signature @@ -85,15 +86,15 @@ def isLightMode_Linux() -> bool: ... [Show source in __init__.py:10](../../../getostheme/__init__.py#L10) For MacOS BSD-3-Clause albertosottile -(https://github.com/albertosottile/darkdetect) - -#### Raises +(https://github.com/albertosottile/darkdetect). -- `OSError` - Cannot load objc +Raises +------ + OSError: Cannot load objc -#### Returns - -- `bool` - Windows is in light mode +Returns +------- + bool: Windows is in light mode #### Signature @@ -105,14 +106,14 @@ def isLightMode_Mac() -> bool: ... ## isLightMode_Windows -[Show source in __init__.py:92](../../../getostheme/__init__.py#L92) +[Show source in __init__.py:95](../../../getostheme/__init__.py#L95) For Windows OS MIT clxmente -(https://github.com/clxmente/Windows-Dark-Mode-Check) - -#### Returns +(https://github.com/clxmente/Windows-Dark-Mode-Check). -- `bool` - Windows is in light mode +Returns +------- + bool: Windows is in light mode #### Signature diff --git a/documentation/reference/getostheme/module.md b/documentation/reference/getostheme/module.md index 2640361..009bf43 100644 --- a/documentation/reference/getostheme/module.md +++ b/documentation/reference/getostheme/module.md @@ -1,8 +1,6 @@ # Module -[Getostheme Index](../README.md#getostheme-index) / -[Getostheme](./index.md#getostheme) / -Module +[Getostheme Index](../README.md#getostheme-index) / [Getostheme](./index.md#getostheme) / Module > Auto-generated documentation for [getostheme.__main__](../../../getostheme/__main__.py) module. - [Module](#module) diff --git a/pyproject.toml b/pyproject.toml index 16e5236..6ccabcb 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "getostheme" -version = "2021" +version = "2024.0.1" license = "mit" description = "Use this module to get the OS theme (dark/light)" authors = ["FredHappyface"] @@ -27,6 +27,9 @@ getostheme = 'getostheme:cli' python = "^3.8" PyQt5 = { version = "<6,>=5.15.10", optional = true } +[tool.poetry.extras] +qt = ["PyQt5"] + [tool.poetry.group.dev.dependencies] pytest = "^7.4.4" handsdown = "^2.1.0" diff --git a/requirements.txt b/requirements.txt index e69de29..8b13789 100644 --- a/requirements.txt +++ b/requirements.txt @@ -0,0 +1 @@ +