dripfetch 0.1.1__tar.gz → 0.2.1__tar.gz

dripfetch-0.2.1/PKG-INFO

@@ -0,0 +1,292 @@
+Metadata-Version: 2.4
+Name: dripfetch
+Version: 0.2.1
+Summary: A customizable terminal system information display with animated rain.
+Author: Amir Shygun
+License: MIT License
+        
+        Copyright (c) 2026 Amir Shygun
+        
+        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.
+        
+Keywords: terminal,system information,fetch,curses,cli
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: System
+Classifier: Topic :: Terminals
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: psutil
+Requires-Dist: ruamel.yaml
+Dynamic: license-file
+
+# Dripfetch
+
+<p align="center">
+  <img src="docs/dripfetch.gif" alt="Dripfetch demo" width="900">
+</p>
+
+<p align="center">
+  A customizable terminal system information display with animated rain.
+</p>
+
+<p align="center">
+  <a href="https://github.com/a-shygun/dripfetch/issues">Issues</a>
+</p>
+
+---
+
+## What is Dripfetch?
+
+Dripfetch is a customizable terminal TUI that combines system information, animated rain, clocks, logos, text, and other information into a single configurable display.
+
+Everything is controlled through a YAML configuration file, allowing you to customize the appearance and layout without modifying the source code.
+
+### Features
+
+- Animated terminal rain
+- System information
+- Large customizable clock
+- ASCII and text boxes
+- Platform logos
+- Weather information
+- Mouse interaction
+- Keyboard-controlled box movement
+- Multiple keyboard layouts
+- Custom colors, borders, padding, and positioning
+- YAML configuration
+- ANSI-based terminal rendering
+
+---
+
+## Screenshots & Demo
+
+<p align="center">
+  <img src="docs/screenshots/dripfetch_terminal.png" alt="Dripfetch terminal" width="800">
+</p>
+
+<p align="center">
+  <img src="docs/screenshots/dripfetch_onlyrain.png" alt="Dripfetch rain" width="800">
+</p>
+
+<p align="center">
+  <img src="docs/screenshots/dripfetch_multiple_raindrops.png" alt="Dripfetch multiple raindrops" width="800">
+</p>
+
+<p align="center">
+  <img src="docs/screenshots/dripfetch_onlybox.png" alt="Dripfetch boxes" width="800">
+</p>
+
+A short terminal recording is also available:
+
+**[Watch the Dripfetch demo](docs/dripfetch.mov)**
+
+---
+
+# Installation
+
+## PyPI
+
+The easiest way to install Dripfetch is through PyPI:
+
+```bash
+pip install dripfetch
+```
+
+Then run:
+
+```bash
+dripfetch
+```
+
+---
+
+## Install from source
+
+If you want to install the latest source directly from GitHub:
+
+```bash
+git clone https://github.com/a-shygun/dripfetch.git
+cd dripfetch
+pip install .
+```
+
+Then:
+
+```bash
+dripfetch
+```
+
+### Using the installation script
+
+The repository also includes an installation script that creates an isolated virtual environment and installs Dripfetch into it.
+
+```bash
+git clone https://github.com/a-shygun/dripfetch.git
+cd dripfetch
+chmod +x install.sh
+./install.sh
+```
+
+The script:
+
+- Creates `~/dripfetch`
+- Creates a virtual environment at `~/dripfetch/.venv`
+- Installs Dripfetch into the virtual environment
+- Creates `~/.local/bin/dripfetch`
+- Adds `~/.local/bin` to your shell PATH when necessary
+
+Python 3 is still required for this method.
+
+---
+
+# Usage
+
+Start Dripfetch with:
+
+```bash
+dripfetch
+```
+
+Basic controls:
+
+| Key | Action |
+|---|---|
+| `q` | Quit |
+| `Space` | Pause/resume rain |
+| `W A S D` | Move selected box |
+| Arrow keys | Move selected box |
+| `Esc` | Deselect box |
+| Mouse | Select a box |
+
+Dripfetch supports different keyboard layouts, including QWERTY, AZERTY, and QWERTZ.
+
+---
+
+# Configuration
+
+Dripfetch uses a YAML configuration file.
+
+Create or restore the default configuration:
+
+```bash
+dripfetch --init-config
+```
+
+Show the active configuration path:
+
+```bash
+dripfetch --config-path
+```
+
+Use a custom configuration:
+
+```bash
+dripfetch --config path/to/config.yaml
+```
+
+The configuration file controls the appearance, layout, boxes, rain, colors, borders, padding, and other behavior.
+
+---
+
+# Uninstallation
+
+If you installed Dripfetch with `pip`:
+
+```bash
+pip uninstall dripfetch
+```
+
+If you installed it using `install.sh`, run the included uninstall script from the repository:
+
+```bash
+chmod +x uninstall.sh
+./uninstall.sh
+```
+
+The uninstall script removes the Dripfetch virtual environment and command symlink while preserving:
+
+```text
+~/dripfetch
+~/.config/dripfetch/config.yaml
+```
+
+This means your source files and configuration are not automatically deleted.
+
+If you want to completely remove the remaining installation directory:
+
+```bash
+rm -rf ~/dripfetch
+```
+
+To also remove your Dripfetch configuration:
+
+```bash
+rm -rf ~/.config/dripfetch
+```
+
+---
+
+# Next Update
+
+The next update is planned to expand Dripfetch beyond its current feature set.
+
+Planned improvements include:
+
+- Adding more box types
+- Adding Dripfetch to Homebrew
+- Adding packages for Linux package managers
+- Creating a complete Dripfetch Wiki with detailed documentation
+- Expanding configuration and customization documentation
+
+---
+
+# Development
+
+Clone the repository:
+
+```bash
+git clone https://github.com/a-shygun/dripfetch.git
+cd dripfetch
+```
+
+For development, an editable installation is recommended:
+
+```bash
+pip install -e .
+```
+
+Run the test suite:
+
+```bash
+pytest
+```
+
+---
+
+# License
+
+Dripfetch is released under the [MIT License](LICENSE).

dripfetch-0.2.1/README.md

@@ -0,0 +1,247 @@
+# Dripfetch
+
+<p align="center">
+  <img src="docs/dripfetch.gif" alt="Dripfetch demo" width="900">
+</p>
+
+<p align="center">
+  A customizable terminal system information display with animated rain.
+</p>
+
+<p align="center">
+  <a href="https://github.com/a-shygun/dripfetch/issues">Issues</a>
+</p>
+
+---
+
+## What is Dripfetch?
+
+Dripfetch is a customizable terminal TUI that combines system information, animated rain, clocks, logos, text, and other information into a single configurable display.
+
+Everything is controlled through a YAML configuration file, allowing you to customize the appearance and layout without modifying the source code.
+
+### Features
+
+- Animated terminal rain
+- System information
+- Large customizable clock
+- ASCII and text boxes
+- Platform logos
+- Weather information
+- Mouse interaction
+- Keyboard-controlled box movement
+- Multiple keyboard layouts
+- Custom colors, borders, padding, and positioning
+- YAML configuration
+- ANSI-based terminal rendering
+
+---
+
+## Screenshots & Demo
+
+<p align="center">
+  <img src="docs/screenshots/dripfetch_terminal.png" alt="Dripfetch terminal" width="800">
+</p>
+
+<p align="center">
+  <img src="docs/screenshots/dripfetch_onlyrain.png" alt="Dripfetch rain" width="800">
+</p>
+
+<p align="center">
+  <img src="docs/screenshots/dripfetch_multiple_raindrops.png" alt="Dripfetch multiple raindrops" width="800">
+</p>
+
+<p align="center">
+  <img src="docs/screenshots/dripfetch_onlybox.png" alt="Dripfetch boxes" width="800">
+</p>
+
+A short terminal recording is also available:
+
+**[Watch the Dripfetch demo](docs/dripfetch.mov)**
+
+---
+
+# Installation
+
+## PyPI
+
+The easiest way to install Dripfetch is through PyPI:
+
+```bash
+pip install dripfetch
+```
+
+Then run:
+
+```bash
+dripfetch
+```
+
+---
+
+## Install from source
+
+If you want to install the latest source directly from GitHub:
+
+```bash
+git clone https://github.com/a-shygun/dripfetch.git
+cd dripfetch
+pip install .
+```
+
+Then:
+
+```bash
+dripfetch
+```
+
+### Using the installation script
+
+The repository also includes an installation script that creates an isolated virtual environment and installs Dripfetch into it.
+
+```bash
+git clone https://github.com/a-shygun/dripfetch.git
+cd dripfetch
+chmod +x install.sh
+./install.sh
+```
+
+The script:
+
+- Creates `~/dripfetch`
+- Creates a virtual environment at `~/dripfetch/.venv`
+- Installs Dripfetch into the virtual environment
+- Creates `~/.local/bin/dripfetch`
+- Adds `~/.local/bin` to your shell PATH when necessary
+
+Python 3 is still required for this method.
+
+---
+
+# Usage
+
+Start Dripfetch with:
+
+```bash
+dripfetch
+```
+
+Basic controls:
+
+| Key | Action |
+|---|---|
+| `q` | Quit |
+| `Space` | Pause/resume rain |
+| `W A S D` | Move selected box |
+| Arrow keys | Move selected box |
+| `Esc` | Deselect box |
+| Mouse | Select a box |
+
+Dripfetch supports different keyboard layouts, including QWERTY, AZERTY, and QWERTZ.
+
+---
+
+# Configuration
+
+Dripfetch uses a YAML configuration file.
+
+Create or restore the default configuration:
+
+```bash
+dripfetch --init-config
+```
+
+Show the active configuration path:
+
+```bash
+dripfetch --config-path
+```
+
+Use a custom configuration:
+
+```bash
+dripfetch --config path/to/config.yaml
+```
+
+The configuration file controls the appearance, layout, boxes, rain, colors, borders, padding, and other behavior.
+
+---
+
+# Uninstallation
+
+If you installed Dripfetch with `pip`:
+
+```bash
+pip uninstall dripfetch
+```
+
+If you installed it using `install.sh`, run the included uninstall script from the repository:
+
+```bash
+chmod +x uninstall.sh
+./uninstall.sh
+```
+
+The uninstall script removes the Dripfetch virtual environment and command symlink while preserving:
+
+```text
+~/dripfetch
+~/.config/dripfetch/config.yaml
+```
+
+This means your source files and configuration are not automatically deleted.
+
+If you want to completely remove the remaining installation directory:
+
+```bash
+rm -rf ~/dripfetch
+```
+
+To also remove your Dripfetch configuration:
+
+```bash
+rm -rf ~/.config/dripfetch
+```
+
+---
+
+# Next Update
+
+The next update is planned to expand Dripfetch beyond its current feature set.
+
+Planned improvements include:
+
+- Adding more box types
+- Adding Dripfetch to Homebrew
+- Adding packages for Linux package managers
+- Creating a complete Dripfetch Wiki with detailed documentation
+- Expanding configuration and customization documentation
+
+---
+
+# Development
+
+Clone the repository:
+
+```bash
+git clone https://github.com/a-shygun/dripfetch.git
+cd dripfetch
+```
+
+For development, an editable installation is recommended:
+
+```bash
+pip install -e .
+```
+
+Run the test suite:
+
+```bash
+pytest
+```
+
+---
+
+# License
+
+Dripfetch is released under the [MIT License](LICENSE).

{dripfetch-0.1.1 → dripfetch-0.2.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "dripfetch"
-version = "0.1.1"
+version = "0.2.1"
 description = "A customizable terminal system information display with animated rain."
 readme = "README.md"
 requires-python = ">=3.12"
@@ -32,7 +32,7 @@ dependencies = [
 ]
 
 [project.scripts]
-dripfetch = "dripfetch.cli:main"
+dripfetch = "dripfetch.app.cli:main"
 
 [tool.setuptools.packages.find]
 where = ["src"]
@@ -53,4 +53,4 @@ select = ["E", "F", "I", "UP", "B", "SIM"]
 
 [tool.ruff.format]
 quote-style = "double"
-indent-style = "space"
+indent-style = "space"

dripfetch-0.2.1/src/dripfetch/__init__.py

@@ -0,0 +1,3 @@
+from importlib.metadata import version
+
+__version__ = version("dripfetch")

{dripfetch-0.1.1 → dripfetch-0.2.1}/src/dripfetch/__main__.py

@@ -1,4 +1,4 @@
-from .cli import main
+from .app.cli import main
 
 if __name__ == "__main__":
     main()

{dripfetch-0.1.1/src/dripfetch → dripfetch-0.2.1/src/dripfetch/app}/app.py

@@ -1,19 +1,10 @@
 import curses
 from pathlib import Path
 
-from .box import Box
-from .config import (
-    DEFAULT_BACKGROUND,
-    load_config,
-    save_config,
-)
-from .rain import Rain
-from .terminal import (
-    Renderer,
-    cleanup,
-    parse_color,
-    setup,
-)
+from ..box import Box
+from ..rain import Rain
+from .config import load_config, save_config
+from .terminal import Renderer, cleanup, parse_color, setup
 
 
 class App:
@@ -28,12 +19,7 @@ class App:
     def initialize(self, stdscr):
         self.config = load_config(self.config_path)
         setup(stdscr)
-        background = parse_color(
-            self.config.get(
-                "background",
-                DEFAULT_BACKGROUND,
-            )
-        )
+        background = parse_color(self.config.get("background", "#000000FF"))
         self.renderer = Renderer(
             stdscr,
             background,
@@ -59,29 +45,18 @@ class App:
         except curses.error:
             return
         if state & curses.BUTTON1_CLICKED:
-            self.box.handle_mouse(
-                x,
-                y,
-            )
+            self.box.handle_mouse(x, y)
 
     def handle_key(self, key):
         if key == ord("q"):
             return False
         if key == curses.KEY_MOUSE:
             self.handle_mouse()
-        elif key == ord(" "):
+            return True
+        if key == ord(" "):
             self.paused = not self.paused
-            if self.paused:
-                self.rain.pause()
-            else:
-                self.rain.resume()
-        elif key == 27 or key in (
-            ord("w"),
-            ord("a"),
-            ord("s"),
-            ord("d"),
-        ):
-            self.box.handle_key(key)
+            return True
+        self.box.handle_key(key)
         return True
 
     def update(self):