Initial commit

Author: TheAxelander

.github/workflows/publish.yml

@@ -0,0 +1,34 @@
+name: Publish Console App
+
+on:
+  push:
+    tags:
+      - "*"
+
+jobs:
+  publish:
+
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.10"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      - name: Build app
+        run: python -m build
+
+      - name: Create GitHub release
+        uses: softprops/action-gh-release@v1
+        with:
+          files: dist/wtf-${{ github.ref_name }}-py3-none-any.whl
+          token: ${{ secrets.GITHUB_TOKEN }}  

.gitignore

@@ -0,0 +1,5 @@
+/.idea
+/.venv
+/dist
+/*.egg-info
+.env

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Alexander Preibisch
+
+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.

README.md

@@ -0,0 +1,71 @@
+# wtf
+
+**A small helper to display cheatsheets, shortcuts and others inside your terminal.**
+
+![Demo](assets/demo.gif)
+
+## Requirements
+
+- fzf
+- config file (see Configuration)
+
+## Installation
+
+Download [latest release](https://github.com/TheAxelander/wtf/releases/latest) and install it via `pipx`
+
+``` bash
+apt install python3 python3-pipx
+pipx install wtf-x.x.x-py3-none-any.whl
+```
+
+Optionally create a venv for development
+
+``` bash
+git clone https://github.com/TheAxelander/wtf.git
+cd wtf
+python3 -m venv venv
+source venv/bin/activate
+pip install -r requirements.txt
+```
+
+## Usage
+
+Without any parameter `fzf` is used to select a file which is then rendered. 
+
+``` bash
+wtf
+
+>>> fzf screen is shown
+```
+
+Appending a `sheet` (simple file name) renders the file directly without any further selection
+
+``` bash
+wtf tmux
+
+>>> tmux file will be displayed
+```
+
+## Configuration
+
+See below example config file which is required in `~/.config/wtf/wtf.conf`
+
+``` ini
+CHEATSHEET_REPO=/home/axelander/.local/wtf
+TABLE_DELIMITER=|
+PREVIEW_COMMAND=cat #You could also use wtf itself to render the file inside the fzf preview
+```
+
+## Example file
+
+Files need to be written to be compatible with [Rich](https://github.com/Textualize/rich) to render a table like below. The first line will be displayed as header.
+
+```
+Command                 |Description
+tmux                    |New session
+tmux new                |New session
+tmux new -s sessionname |New session with name
+tmux a                  |Attach session
+tmux a -t sessionname   |Attach to named session
+[bold cyan]CTRL[/bold cyan] + [bold cyan]B[/bold cyan] [bold yellow]D[/bold yellow]|Detach session
+```

assets/demo.gif

@@ -0,0 +1,30 @@
+[build-system]
+requires = ["setuptools>=42", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "wtf"
+version = "1.0.0"
+authors = [{ name = "Alexander Preibisch", email = "[email protected]" }]
+description = "Print some common notes in table format"
+readme = "README.md"
+license = { file = "LICENSE" }
+classifiers = [
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent"
+]
+requires-python = ">=3.10"
+dependencies = [
+    "python-dotenv>=1.1.0",
+    "rich>=13.7.1"
+]
+
+[project.scripts]
+wtf = "wtf.main:main"
+
+[project.urls]
+homepage = "https://github.com/TheAxelander/wtf"
+repository = "https://github.com/TheAxelander/wtf"

pyproject.toml

@@ -0,0 +1,3 @@
+build
+python-dotenv
+rich

requirements.txt

@@ -0,0 +1,20 @@
+from setuptools import setup
+
+setup(
+    name='wtf',
+    version='0.1',
+    packages=['wtf'],
+    install_requires=[
+        'rich'
+    ],
+    entry_points={
+        'console_scripts': [
+            'wtf=wtf.main:main'
+        ],
+    },
+    url='',
+    license='MIT',
+    author='Alexander Preibisch',
+    author_email='[email protected]',
+    description=''
+)

setup.py

@@ -0,0 +1,97 @@
+import argparse
+import subprocess
+from dotenv import dotenv_values
+from rich.console import Console
+from rich.table import Table
+from pathlib import Path
+
+console = Console()
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument('sheet', nargs='?', type=str, help="Specific cheatsheet which should be printed")
+
+    try:
+        config = get_config()
+        directory = Path(config['CHEATSHEET_REPO']).expanduser()
+    except Exception as e:
+        console.print(f"[bold red]Error reading config: {e}[/bold red]")
+        exit(1)
+
+    args = parser.parse_args()
+    if args.sheet:
+        render_file(directory / args.sheet)
+    else:
+        select_file_via_fzf(directory)
+
+
+def get_config():
+    config_path = Path.home() / '.config' / 'wtf' / 'wtf.conf'
+    if not config_path.exists():
+        raise FileNotFoundError(f"Config file not found: {config_path}")
+
+    return dotenv_values(config_path)
+
+
+def select_file_via_fzf(directory):
+    if not directory.exists():
+        console.print(f"[bold red]Directory {directory} does not exist![/bold red]")
+        exit(1)
+
+    # Run fzf to list files in from directory
+    try:
+        try:
+            config = get_config()
+            preview_command = config.get('PREVIEW_COMMAND', 'cat')
+        except Exception as e:
+            console.print(f"[bold red]Error reading config: {e}[/bold red]")
+            exit(1)
+            
+        selected_file = subprocess.check_output(
+            ['fzf', '--preview', f'{preview_command} {{}}'],  # Run fzf and show a preview of the file content
+            cwd=str(directory),  # working directory
+            text=True
+        ).strip()
+
+        if selected_file:
+            render_file(directory / selected_file)
+
+    except subprocess.CalledProcessError as e:
+        console.print(f"[bold red]Error with fzf command: {e}[/bold red]")
+
+
+def render_file(file_path):
+    if not file_path.exists():
+        console.print(f"[red]File not found: {file_path}[/red]")
+        return
+
+    try:
+        config = get_config()
+        delimiter = config.get('TABLE_DELIMITER', ',')
+    except Exception as e:
+        console.print(f"[bold red]Error reading config: {e}[/bold red]")
+        exit(1)
+
+    with open(file_path, 'r') as f:
+        lines = [line.strip() for line in f if line.strip()]
+
+    if not lines:
+        console.print("[yellow]File is empty.[/yellow]")
+        return
+
+    headers = lines[0].split(delimiter)
+    table = Table(show_header=True, header_style="bold cyan", show_lines=True)
+
+    for header in headers:
+        table.add_column(header.strip())
+    table.columns[0].no_wrap=True
+
+    for line in lines[1:]:
+        row = [col.strip() for col in line.split(delimiter)]
+        table.add_row(*row)
+
+    console.print(table)
+
+
+if __name__ == '__main__':
+    main()