bctl 0.0.1__tar.gz → 0.0.1.dev0__tar.gz

{bctl-0.0.1 → bctl-0.0.1.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bctl
-Version: 0.0.1
+Version: 0.0.1.dev0
 Summary: service for simultaneously controlling brightness of laptop & external displays
 License-Expression: MIT
 Project-URL: homepage, https://github.com/laur89/bctl
@@ -30,7 +30,9 @@ for screen (dis)connections. Desktop notifications are shown on brightness chang
 
 ## Installation
 
-`$ pipx instal bctl`
+~~`$ pipx instal bctl`~~  not published yet
+
+`$ pipx install git+ssh://git@github.com/laur89/bctl.git`
 
 Note this will install the client & daemon executables, but it's user
 responsibility to launch the daemon process, covered below.
@@ -116,7 +118,7 @@ Meaning it's best to choose one of the options, not both.
 As mentioned earlier, a daemon process needs to be started that keeps track of
 the displays. Easiest way to do so would be utilizing your OS's process
 manager. An example of a systemd user service file (e.g.
-`~/.config/systemd/user/bctld.service`) would be:
+`~/.config/systemd/user/bctld.conf`) would be:
 
 ```
 [Unit]
@@ -136,12 +138,6 @@ RestartPreventExitStatus=100
 WantedBy=graphical-session.target
 ```
 
-Enable & start this unit by running
-
-```sh
-$ systemctl --user enable --now bctld.service
-```
-
 ### Client
 
 With demon running, the client is used to send commands to the daemon. List
@@ -182,7 +178,7 @@ part of internal comms spec.
 
 User configuration file is read from `$XDG_CONFIG_HOME/bctl/config.json`.
 For full config list see the [config.py](./bctl/config.py) file that defines the defaults,
-but the most important ones you might want to be aware of or change are:
+but the most important ones you might want to consider changing are:
 
 | Config | Type | Default | Description |
 | --- | --- | --- | --- |

{bctl-0.0.1 → bctl-0.0.1.dev0}/README.md

@@ -7,7 +7,9 @@ for screen (dis)connections. Desktop notifications are shown on brightness chang
 
 ## Installation
 
-`$ pipx instal bctl`
+~~`$ pipx instal bctl`~~  not published yet
+
+`$ pipx install git+ssh://git@github.com/laur89/bctl.git`
 
 Note this will install the client & daemon executables, but it's user
 responsibility to launch the daemon process, covered below.
@@ -93,7 +95,7 @@ Meaning it's best to choose one of the options, not both.
 As mentioned earlier, a daemon process needs to be started that keeps track of
 the displays. Easiest way to do so would be utilizing your OS's process
 manager. An example of a systemd user service file (e.g.
-`~/.config/systemd/user/bctld.service`) would be:
+`~/.config/systemd/user/bctld.conf`) would be:
 
 ```
 [Unit]
@@ -113,12 +115,6 @@ RestartPreventExitStatus=100
 WantedBy=graphical-session.target
 ```
 
-Enable & start this unit by running
-
-```sh
-$ systemctl --user enable --now bctld.service
-```
-
 ### Client
 
 With demon running, the client is used to send commands to the daemon. List
@@ -159,7 +155,7 @@ part of internal comms spec.
 
 User configuration file is read from `$XDG_CONFIG_HOME/bctl/config.json`.
 For full config list see the [config.py](./bctl/config.py) file that defines the defaults,
-but the most important ones you might want to be aware of or change are:
+but the most important ones you might want to consider changing are:
 
 | Config | Type | Default | Description |
 | --- | --- | --- | --- |

{bctl-0.0.1 → bctl-0.0.1.dev0}/bctl/client.py

@@ -37,12 +37,9 @@ class Client(object):
         reader, writer = await self._open_write_socket(cmd)
 
         data = await reader.read()
-        data = json.loads(data.decode())
-        self.logger.debug(f'received response {data} from daemon')
-        [code, *rest] = data
-        outf = sys.stdout if code == 0 else sys.stderr
+        [code, *rest] = json.loads(data.decode())
         for i in rest:
-            print(i, file=outf)
+            print(i)
         await self._close_socket(writer)
         sys.exit(code)
 

{bctl-0.0.1 → bctl-0.0.1.dev0}/bctl/config.py

@@ -60,14 +60,14 @@ class Conf(TypedDict):
 
 
 default_conf: Conf = {
-    'log_lvl': 'INFO',  # daemon log level, doesn't apply to the client
+    'log_lvl': 'INFO',
     'ddcutil_bus_path_prefix': '/dev/i2c-',  # prefix to the bus number
-    'ddcutil_brightness_feature': '10',
+    'ddcutil_brightness_feature': '10',  # str!
     'ddcutil_svcp_flags': ['--skip-ddc-checks'],  # flags passed to [ddcutil setvcp] commands
     'ddcutil_gvcp_flags': [],  # flags passed to [ddcutil getvcp] commands
     'monitor_udev': True,  # monitor udev events for drm subsystem to detect ext. display (dis)connections
     'periodic_init_sec': 0,  # periodically re-init/re-detect monitors; 0 to disable
-    'sync_brightness': False,  # keep all displays' brightnesses at same value/synchronized
+    'sync_brightness': False,  # try to keep all displays' brightnesses at same value/synchronized
     'sync_strategy': 'MEAN',  # if displays' brightnesses differ and are synced, what value to sync them to; only active if sync_brightness=True;
                               # 'MEAN' = set to arithmetic mean, 'LOW' = set to lowest, 'HIGH' = set to highest
     'notify': {
@@ -87,18 +87,18 @@ default_conf: Conf = {
     'udev_event_debounce_sec': 3.0,  # both for debouncing & delay; have experienced missed ext. display detection w/ 1.0
     'msg_consumption_window_sec': 0.1,  # can be set to 0 if no delay/window is required
     'brightness_step': 5,  # %
-    'ignored_displays': [],  # either [ddcutil --brief detect] cmd "Monitor:" value, or <device> in /sys/class/backlight/<device>
-    'ignore_internal_display': False,  # do not control internal (i.e. laptop) display if available
+    'ignored_displays': [],  # either ddcutil's "Monitor:" value, or <device> in /sys/class/backlight/<device>
+    'ignore_internal_display': False,  # do not control internal display if available
     'ignore_external_display': False,  # do not control external display(s) if available
     'main_display_ctl': 'DDCUTIL',  # RAW | DDCUTIL | BRIGHTNESSCTL | BRILLO
     'internal_display_ctl': 'RAW',  # RAW | BRIGHTNESSCTL | BRILLO;  only used if main_display_ctl=DDCUTIL and we're a laptop
     'raw_device_dir': '/sys/class/backlight',  # used if main_display_ctl=RAW OR
-                                               # (main_display_ctl=DDCUTIL AND internal_display_ctl=RAW AND we're a laptop)
-    'fatal_exit_code': 100,  # exit code signifying fatal exit that should not be retried;
+                                               # (main_display_ctl=DDCUTIL and internal_display_ctl=RAW AND we're a laptop)
+    'fatal_exit_code': 100,  # exit code signifying fatal exit code, should not be retried;
                              # you might want to use this value in systemd unit file w/ RestartPreventExitStatus config
     'socket_path': '/tmp/.bctld-ipc.sock',
     'sim': None,  # simulation config, will be set by sim client
-    'state_f_path': '/tmp/.bctld.state',  # state that should survive restarts are stored here
+    'state_f_path': '/tmp/.bctld.state',
     'state': None  # do not set, will be read in from state_f_path
 }
 

{bctl-0.0.1 → bctl-0.0.1.dev0}/bctl.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bctl
-Version: 0.0.1
+Version: 0.0.1.dev0
 Summary: service for simultaneously controlling brightness of laptop & external displays
 License-Expression: MIT
 Project-URL: homepage, https://github.com/laur89/bctl
@@ -30,7 +30,9 @@ for screen (dis)connections. Desktop notifications are shown on brightness chang
 
 ## Installation
 
-`$ pipx instal bctl`
+~~`$ pipx instal bctl`~~  not published yet
+
+`$ pipx install git+ssh://git@github.com/laur89/bctl.git`
 
 Note this will install the client & daemon executables, but it's user
 responsibility to launch the daemon process, covered below.
@@ -116,7 +118,7 @@ Meaning it's best to choose one of the options, not both.
 As mentioned earlier, a daemon process needs to be started that keeps track of
 the displays. Easiest way to do so would be utilizing your OS's process
 manager. An example of a systemd user service file (e.g.
-`~/.config/systemd/user/bctld.service`) would be:
+`~/.config/systemd/user/bctld.conf`) would be:
 
 ```
 [Unit]
@@ -136,12 +138,6 @@ RestartPreventExitStatus=100
 WantedBy=graphical-session.target
 ```
 
-Enable & start this unit by running
-
-```sh
-$ systemctl --user enable --now bctld.service
-```
-
 ### Client
 
 With demon running, the client is used to send commands to the daemon. List
@@ -182,7 +178,7 @@ part of internal comms spec.
 
 User configuration file is read from `$XDG_CONFIG_HOME/bctl/config.json`.
 For full config list see the [config.py](./bctl/config.py) file that defines the defaults,
-but the most important ones you might want to be aware of or change are:
+but the most important ones you might want to consider changing are:
 
 | Config | Type | Default | Description |
 | --- | --- | --- | --- |

{bctl-0.0.1 → bctl-0.0.1.dev0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "bctl"
-version = "0.0.1"
+version = "0.0.1.dev0"
 description = "service for simultaneously controlling brightness of laptop & external displays"
 readme = "README.md"
 requires-python = ">=3.11"