anifetch-cli 1.0.4__tar.gz → 1.0.6__tar.gz

{anifetch_cli-1.0.4/src/anifetch_cli.egg-info → anifetch_cli-1.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: anifetch-cli
-Version: 1.0.4
+Version: 1.0.6
 Summary: Animated terminal fetch with video and audio support.
 Author-email: Notenlish <notenlish@gmail.com>
 Maintainer: Immelancholy
@@ -19,10 +19,10 @@ Classifier: Operating System :: MacOS
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: platformdirs
-Requires-Dist: wcwidth
-Requires-Dist: rich
-Requires-Dist: pynput
+Requires-Dist: platformdirs>=4.5.1
+Requires-Dist: wcwidth>=0.2.14
+Requires-Dist: rich>=14.3.1
+Requires-Dist: pynput>=1.8.1
 Dynamic: license-file
 
 ![anifetch](https://github.com/Notenlish/anifetch/blob/main/docs/anifetch.webp?raw=true)
@@ -33,9 +33,9 @@ This is a small tool built with fastfetch/neofetch, ffmpeg and chafa. It allows
 
 ## Installation
 
-**Quick Links Installation Guide For:** 
+**Quick Links Installation Guide For:**
 
-[Linux](#installation-for-linux-system) • [Windows](#installation-for-windows-winget-or-scoop) • [macOS](#installation-for-macos-homebrew)• [Manual](#manual-installation) • [Development](#developer-installation)
+[Linux](#installation-for-linux-system) • [Windows](#installation-for-windows-winget-or-scoop) • [macOS](#installation-for-macos-homebrew) • [Manual](#manual-installation) • [Development](#developer-installation)
 
 ### Installation for Linux System
 Recommended Python version: 3.11 and later.
@@ -72,12 +72,10 @@ After installation, run this to test if anifetch was installed correctly:
 anifetch example.mp4
 ```
 
-
 Please read our [User guide](#user-guide) for more info on how to use anifetch.
 
 ---
 
-
 ### Installation for Windows (Winget or Scoop)
 
 Check whether you have winget installed by running `winget` in the windows terminal. If you dont have it, install it [here](https://github.com/microsoft/winget-cli/?tab=readme-ov-file#installing-the-client). If you want, you can use [Scoop](https://scoop.sh/) instead. Just replace the `winget` part with `scoop`.
@@ -99,7 +97,6 @@ After installing the necessary dependencies using winget/scoop, install anifetch
 
 Please read our [Post installation](#post-installation) and [User guide](#user-guide) for more info on how to use anifetch.
 
-
 ### Installation for macOS (HomeBrew)
 
 Install homebrew if you haven't installed it already by following the guide [here](https://brew.sh/).
@@ -155,7 +152,6 @@ You can then run the `anifetch` command directly in your terminal.
 
 Since pipx installs packages in an isolated environment, you won't have to worry about dependency conflicts or polluting your global python environment. `anifetch` will behave just like a native cli tool. You can upgrade your installation with `pipx upgrade anifetch`
 
-
 ---
 
 ### Installation for NixOS
@@ -164,12 +160,12 @@ Add the anifetch repo as a flake input:
 
 ```nix
 {
-    inputs = {
-        anifetch = {
-            url = "github:Notenlish/anifetch";
-            inputs.nixpkgs.follows = "nixpkgs";
-        };
+  inputs = {
+    anifetch = {
+      url = "github:Notenlish/anifetch";
+      inputs.nixpkgs.follows = "nixpkgs";
     };
+  };
 }
 ```
 
@@ -182,9 +178,9 @@ Remember to add:
 to your nixos configuration, like I've done here on my system:
 
 ```nix
-    nixosConfigurations = {
-      Enlil = nixpkgs.lib.nixosSystem {
-        specialArgs = {inherit inputs outputs;};
+  nixosConfigurations = {
+    Enlil = nixpkgs.lib.nixosSystem {
+      specialArgs = { inherit inputs outputs; };
 ```
 
 #### ❄️ As a package:
@@ -192,12 +188,13 @@ to your nixos configuration, like I've done here on my system:
 Add anifetch to your packages list like so:
 
 ```nix
-{inputs, pkgs, ...}: {
-    environment.systemPackages = with pkgs; [
-        inputs.anifetch.packages.${pkgs.system}.default
-        fastfetch # Choose either fastfetch or neofetch to run anifetch with
-        neofetch
-    ];
+{ inputs, pkgs, ... }:
+{
+  environment.systemPackages = with pkgs; [
+    inputs.anifetch.packages.${pkgs.stdenv.hostPlatform.system}.default
+    fastfetch # Choose either fastfetch or neofetch to run anifetch with
+    neofetch
+  ];
 }
 ```
 
@@ -206,18 +203,19 @@ Add anifetch to your packages list like so:
 Add the overlay to nixpkgs overlays, then add the package to your package list as you would a package from the normal nixpkgs repo.
 
 ```nix
-{inputs, pkgs, ...}: {
-    nixpkgs = {
-        overlays = [
-            inputs.anifetch.overlays.anifetch
-        ];
-    };
-
-    environment.systemPackages = with pkgs; [
-        anifetch
-        fastfetch # Choose either fastfetch or neofetch to run anifetch with
-        neofetch
+{ inputs, pkgs, ... }:
+{
+  nixpkgs = {
+    overlays = [
+      inputs.anifetch.overlays.default
     ];
+  };
+
+  environment.systemPackages = with pkgs; [
+    anifetch
+    fastfetch # Choose either fastfetch or neofetch to run anifetch with
+    neofetch
+  ];
 }
 ```
 
@@ -238,7 +236,6 @@ pip install -e .
 ```
 > on windows do this to activate the venv instead: `venv\Scripts\activate`. Also on windows you should use `py` instead of `python3`.
 
-
 This installs `anifetch` in editable mode within a local virtual environment for development.
 
 You can then run the program in two ways:
@@ -252,14 +249,13 @@ On Nix you can run:
 
 ```bash
 nix develop
-pip install -e .
 ```
 
-inside the anifetch dir after cloning the repo. This creates a python venv you can re-enter by running `nix develop` inside the project dir.
+To install the package into a devshell. However, it is recommended to use [nix-direnv](https://github.com/nix-community/nix-direnv) to enter the development environment automatically, much like a python venv.
 
 ## User Guide
 
-You don't need to configure anything for `fastfetch` or `neofetch`. If they already work on your machine, `anifetch` will detect and use them automatically. Please note that at least one of these must be installed, otherwise anifetch won't work. **By default, `anifetch` will use fastfetch**. 
+You don't need to configure anything for `fastfetch` or `neofetch`. If they already work on your machine, `anifetch` will detect and use them automatically. Please note that at least one of these must be installed, otherwise anifetch won't work. **By default, `anifetch` will use fastfetch**.
 
 > We dont recommend using neofetch as it is archived. **To use neofetch**, you must append `-nf` to the anifetch command. For some distros you may need to append `--force` to the command too since neofetch is deprecated.
 
@@ -286,7 +282,7 @@ _Note : by default, the video `example.mp4` can directly be used as an example._
 - `--cleanup`: Clears the screen on program exit.
 - `-nf` / `--neofetch`: uses `neofetch` instead of `fastfetch`
 - `-fr` / `--force-render`: Forcefully re-renders the animation while not caring about the cache. Useful if the cache is broken or the contents of the video file has changed.
-- `-i` / `--interval`: Use this to make anifetch update the fetch information over time, sets fetch refresh interval in seconds. Default is -1(never). 
+- `-i` / `--interval`: Use this to make anifetch update the fetch information over time, sets fetch refresh interval in seconds. Default is -1(never).
 - `-b` / `--benchmark`: For testing, prints how long it took to process in seconds.
 - `--force`: Add this argument if you want to use neofetch even if it is deprecated on your system.
 - `--chroma`: Add this argument to chromakey a hexadecimal color from the video using ffmpeg. Syntax: '--chroma \<hex-color>:\<similiarity>:\<blend>'
@@ -329,14 +325,12 @@ Add this to the end of `.bashrc`:
 anifetch [video_file] [other_args_if_needed]
 ```
 
-
 ## Customizing Fastfetch/Neofetch output
 
 For customizing fastfetch/neofetch output, you can check out these pages:
 - [Fastfetch Customization](https://github.com/fastfetch-cli/fastfetch/wiki/Configuration)
 - [Neofetch Customization](https://github.com/dylanaraps/neofetch/wiki/Customizing-Info)
 
-
 ## 📊 Benchmarks
 
 Here's the benchmark from running each cli 10 times. Tested on Windows 11 with Intel I5-12500H processor.
@@ -355,7 +349,7 @@ Make sure to install the dependencies listed on [Prerequisites](#Prerequisites).
 
 If weird characters are appearing in your terminal then your terminals font probably can't render some characters. Consider installling [nerdfonts](https://www.nerdfonts.com/).
 
-If your OS is prompting you about `"Anifetch" is requesting special priviliges` or something similiar after pressing a key to stop the running Anifetch instance, add this argument: `--no-input-restore`. The technical reason for this is that Anifetch records the keys you press and enters them back to the terminal on your behalf. That way you can immediately run whatever command you want, without having to re-enter a key or two. Certain OS's have built-in protections against this as a security notice, which is why you might encounter a security prompt. 
+If your OS is prompting you about `"Anifetch" is requesting special priviliges` or something similiar after pressing a key to stop the running Anifetch instance, add this argument: `--no-input-restore`. The technical reason for this is that Anifetch records the keys you press and enters them back to the terminal on your behalf. That way you can immediately run whatever command you want, without having to re-enter a key or two. Certain OS's have built-in protections against this as a security notice, which is why you might encounter a security prompt.
 
 ## Notes
 
@@ -365,6 +359,8 @@ Also, ffmpeg can generate the the same image for 2 consecutive frames, which may
 
 Currently only the `symbols` format of chafa is supported, formats like kitty, iterm etc. are not supported. If you try to tell chafa to use iterm, kitty etc. it will just override your format with `symbols` mode.
 
+Most fastfetch configs/presets should work out of the box. If you run into an issue with a particular preset, just open an issue and paste your config.
+
 ## What's Next
 
 - [ ] Support different formats like iterm, kitty, sixel etc.

{anifetch_cli-1.0.4 → anifetch_cli-1.0.6}/README.md

@@ -6,9 +6,9 @@ This is a small tool built with fastfetch/neofetch, ffmpeg and chafa. It allows
 
 ## Installation
 
-**Quick Links Installation Guide For:** 
+**Quick Links Installation Guide For:**
 
-[Linux](#installation-for-linux-system) • [Windows](#installation-for-windows-winget-or-scoop) • [macOS](#installation-for-macos-homebrew)• [Manual](#manual-installation) • [Development](#developer-installation)
+[Linux](#installation-for-linux-system) • [Windows](#installation-for-windows-winget-or-scoop) • [macOS](#installation-for-macos-homebrew) • [Manual](#manual-installation) • [Development](#developer-installation)
 
 ### Installation for Linux System
 Recommended Python version: 3.11 and later.
@@ -45,12 +45,10 @@ After installation, run this to test if anifetch was installed correctly:
 anifetch example.mp4
 ```
 
-
 Please read our [User guide](#user-guide) for more info on how to use anifetch.
 
 ---
 
-
 ### Installation for Windows (Winget or Scoop)
 
 Check whether you have winget installed by running `winget` in the windows terminal. If you dont have it, install it [here](https://github.com/microsoft/winget-cli/?tab=readme-ov-file#installing-the-client). If you want, you can use [Scoop](https://scoop.sh/) instead. Just replace the `winget` part with `scoop`.
@@ -72,7 +70,6 @@ After installing the necessary dependencies using winget/scoop, install anifetch
 
 Please read our [Post installation](#post-installation) and [User guide](#user-guide) for more info on how to use anifetch.
 
-
 ### Installation for macOS (HomeBrew)
 
 Install homebrew if you haven't installed it already by following the guide [here](https://brew.sh/).
@@ -128,7 +125,6 @@ You can then run the `anifetch` command directly in your terminal.
 
 Since pipx installs packages in an isolated environment, you won't have to worry about dependency conflicts or polluting your global python environment. `anifetch` will behave just like a native cli tool. You can upgrade your installation with `pipx upgrade anifetch`
 
-
 ---
 
 ### Installation for NixOS
@@ -137,12 +133,12 @@ Add the anifetch repo as a flake input:
 
 ```nix
 {
-    inputs = {
-        anifetch = {
-            url = "github:Notenlish/anifetch";
-            inputs.nixpkgs.follows = "nixpkgs";
-        };
+  inputs = {
+    anifetch = {
+      url = "github:Notenlish/anifetch";
+      inputs.nixpkgs.follows = "nixpkgs";
     };
+  };
 }
 ```
 
@@ -155,9 +151,9 @@ Remember to add:
 to your nixos configuration, like I've done here on my system:
 
 ```nix
-    nixosConfigurations = {
-      Enlil = nixpkgs.lib.nixosSystem {
-        specialArgs = {inherit inputs outputs;};
+  nixosConfigurations = {
+    Enlil = nixpkgs.lib.nixosSystem {
+      specialArgs = { inherit inputs outputs; };
 ```
 
 #### ❄️ As a package:
@@ -165,12 +161,13 @@ to your nixos configuration, like I've done here on my system:
 Add anifetch to your packages list like so:
 
 ```nix
-{inputs, pkgs, ...}: {
-    environment.systemPackages = with pkgs; [
-        inputs.anifetch.packages.${pkgs.system}.default
-        fastfetch # Choose either fastfetch or neofetch to run anifetch with
-        neofetch
-    ];
+{ inputs, pkgs, ... }:
+{
+  environment.systemPackages = with pkgs; [
+    inputs.anifetch.packages.${pkgs.stdenv.hostPlatform.system}.default
+    fastfetch # Choose either fastfetch or neofetch to run anifetch with
+    neofetch
+  ];
 }
 ```
 
@@ -179,18 +176,19 @@ Add anifetch to your packages list like so:
 Add the overlay to nixpkgs overlays, then add the package to your package list as you would a package from the normal nixpkgs repo.
 
 ```nix
-{inputs, pkgs, ...}: {
-    nixpkgs = {
-        overlays = [
-            inputs.anifetch.overlays.anifetch
-        ];
-    };
-
-    environment.systemPackages = with pkgs; [
-        anifetch
-        fastfetch # Choose either fastfetch or neofetch to run anifetch with
-        neofetch
+{ inputs, pkgs, ... }:
+{
+  nixpkgs = {
+    overlays = [
+      inputs.anifetch.overlays.default
     ];
+  };
+
+  environment.systemPackages = with pkgs; [
+    anifetch
+    fastfetch # Choose either fastfetch or neofetch to run anifetch with
+    neofetch
+  ];
 }
 ```
 
@@ -211,7 +209,6 @@ pip install -e .
 ```
 > on windows do this to activate the venv instead: `venv\Scripts\activate`. Also on windows you should use `py` instead of `python3`.
 
-
 This installs `anifetch` in editable mode within a local virtual environment for development.
 
 You can then run the program in two ways:
@@ -225,14 +222,13 @@ On Nix you can run:
 
 ```bash
 nix develop
-pip install -e .
 ```
 
-inside the anifetch dir after cloning the repo. This creates a python venv you can re-enter by running `nix develop` inside the project dir.
+To install the package into a devshell. However, it is recommended to use [nix-direnv](https://github.com/nix-community/nix-direnv) to enter the development environment automatically, much like a python venv.
 
 ## User Guide
 
-You don't need to configure anything for `fastfetch` or `neofetch`. If they already work on your machine, `anifetch` will detect and use them automatically. Please note that at least one of these must be installed, otherwise anifetch won't work. **By default, `anifetch` will use fastfetch**. 
+You don't need to configure anything for `fastfetch` or `neofetch`. If they already work on your machine, `anifetch` will detect and use them automatically. Please note that at least one of these must be installed, otherwise anifetch won't work. **By default, `anifetch` will use fastfetch**.
 
 > We dont recommend using neofetch as it is archived. **To use neofetch**, you must append `-nf` to the anifetch command. For some distros you may need to append `--force` to the command too since neofetch is deprecated.
 
@@ -259,7 +255,7 @@ _Note : by default, the video `example.mp4` can directly be used as an example._
 - `--cleanup`: Clears the screen on program exit.
 - `-nf` / `--neofetch`: uses `neofetch` instead of `fastfetch`
 - `-fr` / `--force-render`: Forcefully re-renders the animation while not caring about the cache. Useful if the cache is broken or the contents of the video file has changed.
-- `-i` / `--interval`: Use this to make anifetch update the fetch information over time, sets fetch refresh interval in seconds. Default is -1(never). 
+- `-i` / `--interval`: Use this to make anifetch update the fetch information over time, sets fetch refresh interval in seconds. Default is -1(never).
 - `-b` / `--benchmark`: For testing, prints how long it took to process in seconds.
 - `--force`: Add this argument if you want to use neofetch even if it is deprecated on your system.
 - `--chroma`: Add this argument to chromakey a hexadecimal color from the video using ffmpeg. Syntax: '--chroma \<hex-color>:\<similiarity>:\<blend>'
@@ -302,14 +298,12 @@ Add this to the end of `.bashrc`:
 anifetch [video_file] [other_args_if_needed]
 ```
 
-
 ## Customizing Fastfetch/Neofetch output
 
 For customizing fastfetch/neofetch output, you can check out these pages:
 - [Fastfetch Customization](https://github.com/fastfetch-cli/fastfetch/wiki/Configuration)
 - [Neofetch Customization](https://github.com/dylanaraps/neofetch/wiki/Customizing-Info)
 
-
 ## 📊 Benchmarks
 
 Here's the benchmark from running each cli 10 times. Tested on Windows 11 with Intel I5-12500H processor.
@@ -328,7 +322,7 @@ Make sure to install the dependencies listed on [Prerequisites](#Prerequisites).
 
 If weird characters are appearing in your terminal then your terminals font probably can't render some characters. Consider installling [nerdfonts](https://www.nerdfonts.com/).
 
-If your OS is prompting you about `"Anifetch" is requesting special priviliges` or something similiar after pressing a key to stop the running Anifetch instance, add this argument: `--no-input-restore`. The technical reason for this is that Anifetch records the keys you press and enters them back to the terminal on your behalf. That way you can immediately run whatever command you want, without having to re-enter a key or two. Certain OS's have built-in protections against this as a security notice, which is why you might encounter a security prompt. 
+If your OS is prompting you about `"Anifetch" is requesting special priviliges` or something similiar after pressing a key to stop the running Anifetch instance, add this argument: `--no-input-restore`. The technical reason for this is that Anifetch records the keys you press and enters them back to the terminal on your behalf. That way you can immediately run whatever command you want, without having to re-enter a key or two. Certain OS's have built-in protections against this as a security notice, which is why you might encounter a security prompt.
 
 ## Notes
 
@@ -338,6 +332,8 @@ Also, ffmpeg can generate the the same image for 2 consecutive frames, which may
 
 Currently only the `symbols` format of chafa is supported, formats like kitty, iterm etc. are not supported. If you try to tell chafa to use iterm, kitty etc. it will just override your format with `symbols` mode.
 
+Most fastfetch configs/presets should work out of the box. If you run into an issue with a particular preset, just open an issue and paste your config.
+
 ## What's Next
 
 - [ ] Support different formats like iterm, kitty, sixel etc.
@@ -362,4 +358,4 @@ I dont remember where I got the example.mp4 video from, if you know the source o
 
 ## Star History
 
-[![Star History Chart](https://api.star-history.com/svg?repos=Notenlish/anifetch&type=Date)](https://www.star-history.com/#Notenlish/anifetch&Date)
+[![Star History Chart](https://api.star-history.com/svg?repos=Notenlish/anifetch&type=Date)](https://www.star-history.com/#Notenlish/anifetch&Date)

anifetch_cli-1.0.6/pyproject.toml

@@ -0,0 +1,60 @@
+[build-system]
+    requires      = ["setuptools>=61.0"]
+    build-backend = "setuptools.build_meta"
+
+[project]
+    name = "anifetch-cli"
+    classifiers = [
+        "Development Status :: 5 - Production/Stable",
+        "Environment :: Console",
+        "Topic :: Terminals",
+        "Operating System :: Microsoft :: Windows",
+        "Operating System :: POSIX",
+        "Operating System :: Unix",
+        "Operating System :: MacOS",
+    ]
+    keywords = [
+        "fetch",
+        "terminal",
+        "cli",
+        "animated",
+        "neofetch",
+        "fastfetch",
+        "anifetch",
+    ]
+    version = "1.0.6"
+    description = "Animated terminal fetch with video and audio support."
+    # If I put everyone here it messes with the "author" meta section.
+    authors = [{ name = "Notenlish", email = "notenlish@gmail.com" }]
+    maintainers = [
+        # If I make it start with immelancholy for some reason it uses gallophostix's gmail for immelancholy.
+        { name = "Gallophostrix", email = "gallophostrix@gmail.com" },
+        { name = "Immelancholy" },
+        { name = "Notenlish", email = "notenlish@gmail.com" },
+    ]
+
+    readme = "README.md"
+    license = { text = "MIT" }
+    requires-python = ">=3.11"
+    dependencies = [
+        "platformdirs>=4.5.1",
+        "wcwidth>=0.2.14",
+        "rich>=14.3.1",
+        "pynput>=1.8.1",
+        # "regex==2026.5.9"
+    ]
+
+[project.urls]
+    Homepage = "https://github.com/Notenlish/anifetch"
+    Issues   = "https://github.com/Notenlish/anifetch/issues"
+
+[project.scripts]
+    anifetch     = "anifetch.__init__:main"
+    anifetch-cli = "anifetch.__init__:main"
+
+[tool.setuptools]
+    packages    = ["anifetch"]
+    package-dir = { "" = "src" }
+
+[tool.setuptools.package-data]
+    anifetch = ["assets/**/*"]

anifetch_cli-1.0.6/src/anifetch/ansi2txt.py

@@ -0,0 +1,56 @@
+#!/usr/bin/env python
+
+# SPDX-License-Identifier: MIT AND AGPL-3.0-only
+
+# Original code from https://github.com/mmlb/ansi2txt
+
+
+def ansi2txt(text: str) -> str:
+    EOF = ""
+    pos = 0
+    output = []
+
+    def getchar():
+        nonlocal pos
+        if pos >= len(text):
+            return EOF
+        ch = text[pos]
+        pos += 1
+        return ch
+
+    ch = None
+
+    while ch != EOF:
+        ch = getchar()
+
+        while ch == "\r":
+            ch = getchar()
+            if ch != "\n":
+                output.append("\r")
+
+        if ch == "\x1b":
+            ch = getchar()
+
+            if ch == "[":
+                ch = getchar()
+                while ch == ";" or ("0" <= ch <= "9") or ch == "?":
+                    ch = getchar()
+
+            elif ch == "]":
+                ch = getchar()
+                if ch != EOF and "0" <= ch <= "9":
+                    while True:
+                        ch = getchar()
+                        if ch == EOF or ord(ch) == 7:
+                            break
+                        elif ch == "\x1b":
+                            ch = getchar()
+                            break
+
+            elif ch == "%":
+                ch = getchar()
+
+        elif ch != EOF:
+            output.append(ch)
+
+    return "".join(output)