swaybeing 0.1.0__tar.gz

swaybeing-0.1.0/LICENSE

@@ -0,0 +1,155 @@
+GNU LESSER GENERAL PUBLIC LICENSE
+Version 3, 29 June 2007
+
+Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+
+Everyone is permitted to copy and distribute verbatim copies of this license
+document, but changing it is not allowed.
+
+This version of the GNU Lesser General Public License incorporates the terms
+and conditions of version 3 of the GNU General Public License, supplemented
+by the additional permissions listed below.
+
+0. Additional Definitions.
+
+As used herein, “this License” refers to version 3 of the GNU Lesser General
+Public License, and the “GNU GPL” refers to version 3 of the
+GNU General Public License.
+
+“The Library” refers to a covered work governed by this License, other than
+an Application or a Combined Work as defined below.
+
+An “Application” is any work that makes use of an interface provided by the
+Library, but which is not otherwise based on the Library. Defining a subclass
+of a class defined by the Library is deemed a mode of using an interface
+provided by the Library.
+
+A “Combined Work” is a work produced by combining or linking an Application
+with the Library. The particular version of the Library with which the
+Combined Work was made is also called the “Linked Version”.
+
+The “Minimal Corresponding Source” for a Combined Work means the Corresponding
+Source for the Combined Work, excluding any source code for portions of the
+Combined Work that, considered in isolation, are based on the Application,
+and not on the Linked Version.
+
+The “Corresponding Application Code” for a Combined Work means the object code
+and/or source code for the Application, including any data and utility programs
+needed for reproducing the Combined Work from the Application, but excluding
+the System Libraries of the Combined Work.
+
+1. Exception to Section 3 of the GNU GPL.
+
+You may convey a covered work under sections 3 and 4 of this License without
+being bound by section 3 of the GNU GPL.
+
+2. Conveying Modified Versions.
+
+If you modify a copy of the Library, and, in your modifications, a facility
+refers to a function or data to be supplied by an Application that uses the
+facility (other than as an argument passed when the facility is invoked),
+then you may convey a copy of the modified version:
+
+    a) under this License, provided that you make a good faith effort to
+    ensure that, in the event an Application does not supply the function or
+    data, the facility still operates, and performs whatever part of its
+    purpose remains meaningful, or
+
+    b) under the GNU GPL, with none of the additional permissions of this
+    License applicable to that copy.
+
+3. Object Code Incorporating Material from Library Header Files.
+
+The object code form of an Application may incorporate material from a header
+file that is part of the Library. You may convey such object code under terms
+of your choice, provided that, if the incorporated material is not limited to
+numerical parameters, data structure layouts and accessors, or small macros,
+inline functions and templates (ten or fewer lines in length),
+you do both of the following:
+
+    a) Give prominent notice with each copy of the object code that the Library
+    is used in it and that the Library and its use are covered by this License.
+
+    b) Accompany the object code with a copy of the GNU GPL
+    and this license document.
+
+4. Combined Works.
+
+You may convey a Combined Work under terms of your choice that, taken together,
+effectively do not restrict modification of the portions of the Library
+contained in the Combined Work and reverse engineering for debugging such
+modifications, if you also do each of the following:
+
+    a) Give prominent notice with each copy of the Combined Work that the
+    Library is used in it and that the Library and its use are covered
+    by this License.
+
+    b) Accompany the Combined Work with a copy of the GNU GPL and
+    this license document.
+
+    c) For a Combined Work that displays copyright notices during execution,
+    include the copyright notice for the Library among these notices, as well
+    as a reference directing the user to the copies of the GNU GPL
+    and this license document.
+
+    d) Do one of the following:
+
+        0) Convey the Minimal Corresponding Source under the terms of this
+        License, and the Corresponding Application Code in a form suitable
+        for, and under terms that permit, the user to recombine or relink
+        the Application with a modified version of the Linked Version to
+        produce a modified Combined Work, in the manner specified by section 6
+        of the GNU GPL for conveying Corresponding Source.
+
+        1) Use a suitable shared library mechanism for linking with the
+        Library. A suitable mechanism is one that (a) uses at run time a
+        copy of the Library already present on the user's computer system,
+        and (b) will operate properly with a modified version of the Library
+        that is interface-compatible with the Linked Version.
+
+    e) Provide Installation Information, but only if you would otherwise be
+    required to provide such information under section 6 of the GNU GPL, and
+    only to the extent that such information is necessary to install and
+    execute a modified version of the Combined Work produced by recombining
+    or relinking the Application with a modified version of the Linked Version.
+    (If you use option 4d0, the Installation Information must accompany the
+    Minimal Corresponding Source and Corresponding Application Code. If you
+    use option 4d1, you must provide the Installation Information in the
+    manner specified by section 6 of the GNU GPL for
+    conveying Corresponding Source.)
+
+5. Combined Libraries.
+
+You may place library facilities that are a work based on the Library side by
+side in a single library together with other library facilities that are not
+Applications and are not covered by this License, and convey such a combined
+library under terms of your choice, if you do both of the following:
+
+    a) Accompany the combined library with a copy of the same work based on
+    the Library, uncombined with any other library facilities, conveyed under
+    the terms of this License.
+
+    b) Give prominent notice with the combined library that part of it is a
+    work based on the Library, and explaining where to find the accompanying
+    uncombined form of the same work.
+
+6. Revised Versions of the GNU Lesser General Public License.
+
+The Free Software Foundation may publish revised and/or new versions of the
+GNU Lesser General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Library as you
+received it specifies that a certain numbered version of the GNU Lesser
+General Public License “or any later version” applies to it, you have the
+option of following the terms and conditions either of that published version
+or of any later version published by the Free Software Foundation. If the
+Library as you received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser General
+Public License ever published by the Free Software Foundation.
+
+If the Library as you received it specifies that a proxy can decide whether
+future versions of the GNU Lesser General Public License shall apply, that
+proxy's public statement of acceptance of any version is permanent
+authorization for you to choose that version for the Library.

swaybeing-0.1.0/PKG-INFO

@@ -0,0 +1,219 @@
+Metadata-Version: 2.4
+Name: swaybeing
+Version: 0.1.0
+Summary: Screentime monitoring app for Sway/i3
+Author-email: OliMoli <olimoli@disroot.org>
+License-Expression: LGPL-3.0-or-later
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: i3ipc>=2.2.0
+Requires-Dist: pydantic>=2.13.0
+Requires-Dist: aiosqlite>=0.21.0
+Requires-Dist: platformdirs>=4.9.0
+Requires-Dist: click>=8.3.0
+Requires-Dist: tabulate>=0.10.0
+Dynamic: license-file
+
+<!--
+vim: ft=markdown softtabstop=2 shiftwidth=2
+-->
+
+# Swaybeing
+A simple daemon for Sway/i3 to track per-app screen time
+
+> [!NOTE]
+> This program is in an early development phase.
+> The API and CLI is subject to changes.
+
+# Screenshots
+![](https://codeberg.org/OliMoli/swaybeing/raw/branch/main/img/db-show.png)
+
+# How it works
+Swaybeing monitors the time you spend in each app. It subscribes to window changes through the i3/Sway IPC socket. When a window is closed or the focus changes to a different app, it compares current timestamp with the timestamp snapshotted when you started using the app and adds it to a write queue. The queue is then written to a database (each 5 minutes by default).
+
+Usage stats are stored in an SQLite database. Each day is divided into equal time periods (of the length of 3 hours by default). App usage data is split between those periods. This is a balance between inefficient storing of linear app usage timestamps and not dividing them at all. Changing the period length will only take effect next day if current day already contains usage data.
+
+Daylight savings are also handled clearly. Swaybeing internally uses the UTC timezone, which is later visually converted to your current timezone when running the `swaybeingctl db show` command.
+
+# Installation
+
+## Nix
+To test it out, you can enter a temporary nix shell:
+```nix
+nix shell git+https://codeberg.org/OliMoli/swaybeing
+```
+
+For a permanent installation, first add Swaybeing to your flake:
+```nix
+{
+  inputs = {
+    # ... other inputs
+
+    swaybeing = {
+      url = "git+https://codeberg.org/OliMoli/swaybeing";
+      inputs.nixpkgs.follows = "nixpkgs";
+    };
+  };
+  
+  # ... rest of your flake
+
+  outputs = inputs @ { self, nixpkgs, ... }: {
+    # example host, replace with your own!
+    nixosConfigurations.example = nixpkgs.lib.nixosSystem {
+      # ... rest of the system
+
+      specialArgs = {
+        # This is important!
+        inherit inputs;
+      }
+    };
+  };
+}
+```
+
+Then, import the module and set `services.swaybeing.enable = true;`. It will automatically install the package and configure the systemd user service.
+```nix
+{ inputs, ... }: {
+  modules = [
+    inputs.swaybeing.nixosModules.default # System module (appiles to all users)
+    inputs.swaybeing.homeModules.default # Home module (applies to a single user)
+  ];
+
+  services.swaybeing = {
+    enable = true; # install the package and enable the autostart service
+
+    # Optional values with examples:
+    package = inputs.swaybeing.packages.${pkgs.system}.default; # specify a custom Swaybeing package to use instead
+    extraOptions = [ "-l", "debug" ]; # extra command line arguments to be passed to the swaybeingd command
+    systemdTargets = [ "sway-session.target" ]; # systemd target which triggers the start of swaybeingd; highly recommended to set
+
+    # Home Manager only: generate config.json
+    config = {
+      period_length = 24;
+      commit_interval = 60;
+    };
+  };
+}
+```
+
+If you prefer not to use the module, you can install the packages manually instead:
+```nix
+{ pkgs, inputs, ... }:
+{
+  environment.systemPackages = [ inputs.swaybeing.packages.${pkgs.system}.default ]; # NixOS
+  home.packages = [ inputs.swaybeing.packages.${pkgs.system}.default ]; # Home Manager
+}
+```
+
+Once Swaybeing gets more stable I'll PR it to Nixpkgs.
+
+## Virtual env
+To test it out, clone the repo and source the `venv-setup` script, or `venv-setup.fish` if you use fish.
+
+It will automatically create a temporary venv, drop you into it and source shell completions.
+
+## PyPI
+A PyPI package is available [here](https://pypi.org/project/swaybeing)
+
+# Setup
+Put this line in your Sway/i3 config:
+```
+exec --no-startup-id swaybeingd
+```
+> [!NOTE]
+> If you're a NixOS/Home Manager user, there's already a systemd unit prepared. See above for more info.
+
+You can also add Swayidle hooks to pause monitoring screentime when you're idle:
+```
+# Sample screen lock hook
+lock 'swaybeingctl msg pause; your-locker; swaybeingctl msg resume'
+unlock 'swaybeingctl msg resume; your-unlocker'
+before-sleep 'loginctl lock-session'
+
+# Stop monitoring after 1 minute of idling
+timeout 60 'swaybeingctl msg pause' resume 'swaybeingctl msg resume'
+```
+or if you use Home Manager:
+```nix
+{ config, pkgs, inputs, ... }:
+let
+  swaybeing = "${inputs.swaybeing.packages.${pkgs.system}.default}";
+  # or
+  swaybeing = config.services.swaybeing.package;
+
+  swaybeingctl = "${swaybeing}/bin/swaybeingctl";
+in
+{
+  services.swayidle = {
+    enable = true;
+    events = {
+      # Sample screen lock hook
+      lock = "${swaybeingctl} msg pause; your-locker; ${swaybeingctl} msg resume";
+      unlock = "${swaybeingctl} msg resume; your-unlocker";
+      before-sleep = "${pkgs.systemd}/bin/loginctl lock-session";
+    };
+
+    timeouts = [
+      {
+        # Stop monitoring after 1 minute of idling
+        timeout = 60;
+        command = "${swaybeingctl} msg pause";
+        resumeCommand = "${swaybeingctl} msg resume";
+      }
+    ];
+  };
+}
+```
+
+# Usage
+The `swaybeingd` command launches the main daemon.
+
+Use `swaybeingctl` to query the database and communicate with the daemon.
+
+Basic commands:
+- `swaybeingctl db show`: show recorded usage information
+- `swaybeingctl msg pause`: pause monitoring time
+- `swaybeingctl msg resume`: resume monitoring time
+
+More commands can be listed by passing the `--help` argument.
+
+# Config
+The config file is located at `$XDG_CONFIG_HOME/swaybeing/config.json`. Config location can be overridden with the `-c` flag
+> [!NOTE]
+> Home Manager users can define the config options in the Home module documented above.
+
+| Key               | Default value                            | Description                                                                                                    |
+| ----------------- | ---------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
+| `autocommit`      | `false`                                  | Automatically write all changes after a window event (disables internal write queue).                          |
+| `commit_interval` | `60`                                     | How often in seconds to write the changes to the database. Set to `0` to disable this feature.                 |
+| `database`        | `"$XDG_DATA_HOME/swaybeing/database.db"` | Where to store the database. Can be overriden with the `-d` flag.                                              |
+| `period_length`   | `3`                                      | Time period length in hours. Must be divisible by 24. Lower = more accuracy. See "How it works" section above. |
+| `socket`          | `"$XDG_RUNTIME_DIR/swaybeing.socket"`    | Socket path. Can be overriden with the `-s` flag.                                                              |
+
+All paths in the config allow enviromnent variable and home directory (~) expansion.
+
+> [!WARNING]
+> It is not recommended to set both `"autocommit" = false` and `"commit_interval" = 0` at the same time, or the database will only be updated at exit or on `swaybeingctl msg commit`.
+
+# Shell completions
+> [!NOTE]
+> Nix users can skip this section since the Nix package already generates proper shell completions.
+
+Swaybeing uses [Click](https://click.palletsprojects.com) as its argument parsing engine. According to the [docs](https://click.palletsprojects.com/en/stable/) here are the commands to generate completions:
+```shell
+_SWAYBEINGD_COMPLETE=shellname_source swaybeingd
+_SWAYBEINGCTL_COMPLETE=shellname_source swaybeingctl
+```
+
+Replace "`shellname`" with either `bash`, `zsh` or `fish`.
+
+To permanently install a bash/zsh completion, save the completions to files by adding `> filename` to the end of the commands above and add `source filename` to your .bashrc/.zshrc (obviously replace "`filename`" with your own destination filename)
+
+For fish, put the completions in `~/.config/fish/completions/command_name.fish`, replacing "`command_name`" with `swaybeingd` or `swaybeingctl`
+
+# Contributing
+See [CONTRIBUTING.md](https://codeberg.org/OliMoli/swaybeing/src/branch/main/CONTRIBUTING.md).
+
+# License
+This project is licensed under the [LGPL-3.0-or-later](https://codeberg.org/OliMoli/swaybeing/src/branch/main/LICENSE) license.

swaybeing-0.1.0/README.md

@@ -0,0 +1,202 @@
+<!--
+vim: ft=markdown softtabstop=2 shiftwidth=2
+-->
+
+# Swaybeing
+A simple daemon for Sway/i3 to track per-app screen time
+
+> [!NOTE]
+> This program is in an early development phase.
+> The API and CLI is subject to changes.
+
+# Screenshots
+![](https://codeberg.org/OliMoli/swaybeing/raw/branch/main/img/db-show.png)
+
+# How it works
+Swaybeing monitors the time you spend in each app. It subscribes to window changes through the i3/Sway IPC socket. When a window is closed or the focus changes to a different app, it compares current timestamp with the timestamp snapshotted when you started using the app and adds it to a write queue. The queue is then written to a database (each 5 minutes by default).
+
+Usage stats are stored in an SQLite database. Each day is divided into equal time periods (of the length of 3 hours by default). App usage data is split between those periods. This is a balance between inefficient storing of linear app usage timestamps and not dividing them at all. Changing the period length will only take effect next day if current day already contains usage data.
+
+Daylight savings are also handled clearly. Swaybeing internally uses the UTC timezone, which is later visually converted to your current timezone when running the `swaybeingctl db show` command.
+
+# Installation
+
+## Nix
+To test it out, you can enter a temporary nix shell:
+```nix
+nix shell git+https://codeberg.org/OliMoli/swaybeing
+```
+
+For a permanent installation, first add Swaybeing to your flake:
+```nix
+{
+  inputs = {
+    # ... other inputs
+
+    swaybeing = {
+      url = "git+https://codeberg.org/OliMoli/swaybeing";
+      inputs.nixpkgs.follows = "nixpkgs";
+    };
+  };
+  
+  # ... rest of your flake
+
+  outputs = inputs @ { self, nixpkgs, ... }: {
+    # example host, replace with your own!
+    nixosConfigurations.example = nixpkgs.lib.nixosSystem {
+      # ... rest of the system
+
+      specialArgs = {
+        # This is important!
+        inherit inputs;
+      }
+    };
+  };
+}
+```
+
+Then, import the module and set `services.swaybeing.enable = true;`. It will automatically install the package and configure the systemd user service.
+```nix
+{ inputs, ... }: {
+  modules = [
+    inputs.swaybeing.nixosModules.default # System module (appiles to all users)
+    inputs.swaybeing.homeModules.default # Home module (applies to a single user)
+  ];
+
+  services.swaybeing = {
+    enable = true; # install the package and enable the autostart service
+
+    # Optional values with examples:
+    package = inputs.swaybeing.packages.${pkgs.system}.default; # specify a custom Swaybeing package to use instead
+    extraOptions = [ "-l", "debug" ]; # extra command line arguments to be passed to the swaybeingd command
+    systemdTargets = [ "sway-session.target" ]; # systemd target which triggers the start of swaybeingd; highly recommended to set
+
+    # Home Manager only: generate config.json
+    config = {
+      period_length = 24;
+      commit_interval = 60;
+    };
+  };
+}
+```
+
+If you prefer not to use the module, you can install the packages manually instead:
+```nix
+{ pkgs, inputs, ... }:
+{
+  environment.systemPackages = [ inputs.swaybeing.packages.${pkgs.system}.default ]; # NixOS
+  home.packages = [ inputs.swaybeing.packages.${pkgs.system}.default ]; # Home Manager
+}
+```
+
+Once Swaybeing gets more stable I'll PR it to Nixpkgs.
+
+## Virtual env
+To test it out, clone the repo and source the `venv-setup` script, or `venv-setup.fish` if you use fish.
+
+It will automatically create a temporary venv, drop you into it and source shell completions.
+
+## PyPI
+A PyPI package is available [here](https://pypi.org/project/swaybeing)
+
+# Setup
+Put this line in your Sway/i3 config:
+```
+exec --no-startup-id swaybeingd
+```
+> [!NOTE]
+> If you're a NixOS/Home Manager user, there's already a systemd unit prepared. See above for more info.
+
+You can also add Swayidle hooks to pause monitoring screentime when you're idle:
+```
+# Sample screen lock hook
+lock 'swaybeingctl msg pause; your-locker; swaybeingctl msg resume'
+unlock 'swaybeingctl msg resume; your-unlocker'
+before-sleep 'loginctl lock-session'
+
+# Stop monitoring after 1 minute of idling
+timeout 60 'swaybeingctl msg pause' resume 'swaybeingctl msg resume'
+```
+or if you use Home Manager:
+```nix
+{ config, pkgs, inputs, ... }:
+let
+  swaybeing = "${inputs.swaybeing.packages.${pkgs.system}.default}";
+  # or
+  swaybeing = config.services.swaybeing.package;
+
+  swaybeingctl = "${swaybeing}/bin/swaybeingctl";
+in
+{
+  services.swayidle = {
+    enable = true;
+    events = {
+      # Sample screen lock hook
+      lock = "${swaybeingctl} msg pause; your-locker; ${swaybeingctl} msg resume";
+      unlock = "${swaybeingctl} msg resume; your-unlocker";
+      before-sleep = "${pkgs.systemd}/bin/loginctl lock-session";
+    };
+
+    timeouts = [
+      {
+        # Stop monitoring after 1 minute of idling
+        timeout = 60;
+        command = "${swaybeingctl} msg pause";
+        resumeCommand = "${swaybeingctl} msg resume";
+      }
+    ];
+  };
+}
+```
+
+# Usage
+The `swaybeingd` command launches the main daemon.
+
+Use `swaybeingctl` to query the database and communicate with the daemon.
+
+Basic commands:
+- `swaybeingctl db show`: show recorded usage information
+- `swaybeingctl msg pause`: pause monitoring time
+- `swaybeingctl msg resume`: resume monitoring time
+
+More commands can be listed by passing the `--help` argument.
+
+# Config
+The config file is located at `$XDG_CONFIG_HOME/swaybeing/config.json`. Config location can be overridden with the `-c` flag
+> [!NOTE]
+> Home Manager users can define the config options in the Home module documented above.
+
+| Key               | Default value                            | Description                                                                                                    |
+| ----------------- | ---------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
+| `autocommit`      | `false`                                  | Automatically write all changes after a window event (disables internal write queue).                          |
+| `commit_interval` | `60`                                     | How often in seconds to write the changes to the database. Set to `0` to disable this feature.                 |
+| `database`        | `"$XDG_DATA_HOME/swaybeing/database.db"` | Where to store the database. Can be overriden with the `-d` flag.                                              |
+| `period_length`   | `3`                                      | Time period length in hours. Must be divisible by 24. Lower = more accuracy. See "How it works" section above. |
+| `socket`          | `"$XDG_RUNTIME_DIR/swaybeing.socket"`    | Socket path. Can be overriden with the `-s` flag.                                                              |
+
+All paths in the config allow enviromnent variable and home directory (~) expansion.
+
+> [!WARNING]
+> It is not recommended to set both `"autocommit" = false` and `"commit_interval" = 0` at the same time, or the database will only be updated at exit or on `swaybeingctl msg commit`.
+
+# Shell completions
+> [!NOTE]
+> Nix users can skip this section since the Nix package already generates proper shell completions.
+
+Swaybeing uses [Click](https://click.palletsprojects.com) as its argument parsing engine. According to the [docs](https://click.palletsprojects.com/en/stable/) here are the commands to generate completions:
+```shell
+_SWAYBEINGD_COMPLETE=shellname_source swaybeingd
+_SWAYBEINGCTL_COMPLETE=shellname_source swaybeingctl
+```
+
+Replace "`shellname`" with either `bash`, `zsh` or `fish`.
+
+To permanently install a bash/zsh completion, save the completions to files by adding `> filename` to the end of the commands above and add `source filename` to your .bashrc/.zshrc (obviously replace "`filename`" with your own destination filename)
+
+For fish, put the completions in `~/.config/fish/completions/command_name.fish`, replacing "`command_name`" with `swaybeingd` or `swaybeingctl`
+
+# Contributing
+See [CONTRIBUTING.md](https://codeberg.org/OliMoli/swaybeing/src/branch/main/CONTRIBUTING.md).
+
+# License
+This project is licensed under the [LGPL-3.0-or-later](https://codeberg.org/OliMoli/swaybeing/src/branch/main/LICENSE) license.

swaybeing-0.1.0/pyproject.toml

@@ -0,0 +1,35 @@
+[build-system]
+requires = ["setuptools >= 68.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "swaybeing"
+version = "0.1.0" # MAJOR.MINOR.PATCH
+description = "Screentime monitoring app for Sway/i3"
+authors = [{name = "OliMoli", email = "olimoli@disroot.org"}]
+
+requires-python = ">= 3.12"
+
+dependencies = [
+  "i3ipc >= 2.2.0",
+  "pydantic >= 2.13.0",
+  "aiosqlite >= 0.21.0",
+  "platformdirs >= 4.9.0",
+  "click >= 8.3.0",
+  "tabulate >= 0.10.0"
+]
+
+readme = "README.md"
+license = "LGPL-3.0-or-later"
+
+[project.scripts]
+swaybeingd = "swaybeing.daemon:daemon_cli"
+swaybeingctl = "swaybeing.cli:cli"
+
+[tool.ruff.format]
+quote-style = "double"
+
+[tool.ruff.lint]
+select = [
+  "I" # organize imports
+]

swaybeing-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

swaybeing-0.1.0/src/__main__.py

@@ -0,0 +1,6 @@
+# NOTE: this file exists as a fallback
+# Prefer running the swaybeingd script defined in pyproject.toml instead
+
+from swaybeing.daemon import daemon_cli
+
+daemon_cli()