twd-m4sc0 1.5.2__tar.gz → 1.5.4__tar.gz

twd_m4sc0-1.5.4/PKG-INFO

@@ -0,0 +1,155 @@
+Metadata-Version: 2.1
+Name: twd_m4sc0
+Version: 1.5.4
+Summary: A tool to temporarily save and go to a working directory
+Home-page: https://github.com/m4sc0/twd
+Author: m4sc0
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+
+# twd-m4sc0
+
+`twd-m4sc0` is a command-line tool that allows you to temporarily save a working directory and easily navigate back to it. It's designed for developers and users who frequently need to switch between directories in the terminal.
+
+## Features
+
+- Save the current or specified working directory.
+- Go back to a saved directory using an optional alias.
+- List all saved directories with metadata.
+- Unset and delete saved directories.
+- Integrates with your shell for seamless directory management.
+
+## Installation
+
+### Installation using `pip`:
+
+1. Install the package from the `pypi` repository:
+
+```bash
+pip install twd-m4sc0
+```
+
+2. Add the following line to your `.bashrc` or `.zshrc` to set up the shell function:
+
+> Since 1.5.4 you can also set a different command for the `twd` program by replacing `[alias]` in the following code by your custom alias
+
+```bash
+eval $(python3 -m twd --shell [alias])
+```
+
+3. Exit and reopen the terminal or reload using:
+
+```bash
+source ~/.bashrc
+# or
+source ~/.zshrc
+```
+
+## Usage
+
+### Save a directory
+
+- Save the current directory or a specified directory:
+
+```bash
+twd -s [path] [alias]
+```
+
+If no path is specified, the current directory is saved. The alias is optional, and if not provided, an auto-generated ID will be used.
+
+### Go to a saved directory
+
+- Navigate to a saved directory using an optional alias:
+
+```bash
+twd -g [alias]
+```
+
+If no alias is provided, the most recently saved directory will be used. If an alias is provided, it will navigate to the directory associated with that alias.
+
+### List saved directories
+
+- Display a list of all saved directories:
+
+```bash
+twd -l
+```
+
+### Unset the TWD and delete the data file
+
+- Unset and delete the saved directories:
+
+```bash
+twd -u
+```
+
+You can force this action using the `--force` flag to avoid accidental execution.
+
+```bash
+twd -u --force
+```
+
+### Optional Parameters
+
+#### Simple Output
+
+For cleaner, minimal output intended for scripting or piping.
+
+- Example with `--simple-output`:
+
+```bash
+twd -s --simple-output
+/home/user/.config
+```
+
+- Example without `--simple-output`:
+
+```bash
+Saved TWD to /home/user/.config
+```
+
+#### No Output
+
+Suppresses all output (including confirmation messages).
+
+- Example with `--no-output`:
+
+```bash
+twd -s --no-output
+# No output
+```
+
+#### Force
+
+Use the `--force` flag to force certain actions, such as when unsetting directories with the `-u` flag.
+
+- Example:
+
+```bash
+twd -u --force
+TWD File deleted and TWD unset
+```
+
+## Contribution
+
+To set up a development environment:
+
+1. Clone the repository:
+
+```bash
+git clone https://github.com/m4sc0/twd
+cd twd
+```
+
+2. Install the package in editable mode using `pip`:
+
+```bash
+pip install -e .
+```
+
+3. Make your changes, and contribute!

twd_m4sc0-1.5.4/README.md

@@ -0,0 +1,142 @@
+
+# twd-m4sc0
+
+`twd-m4sc0` is a command-line tool that allows you to temporarily save a working directory and easily navigate back to it. It's designed for developers and users who frequently need to switch between directories in the terminal.
+
+## Features
+
+- Save the current or specified working directory.
+- Go back to a saved directory using an optional alias.
+- List all saved directories with metadata.
+- Unset and delete saved directories.
+- Integrates with your shell for seamless directory management.
+
+## Installation
+
+### Installation using `pip`:
+
+1. Install the package from the `pypi` repository:
+
+```bash
+pip install twd-m4sc0
+```
+
+2. Add the following line to your `.bashrc` or `.zshrc` to set up the shell function:
+
+> Since 1.5.4 you can also set a different command for the `twd` program by replacing `[alias]` in the following code by your custom alias
+
+```bash
+eval $(python3 -m twd --shell [alias])
+```
+
+3. Exit and reopen the terminal or reload using:
+
+```bash
+source ~/.bashrc
+# or
+source ~/.zshrc
+```
+
+## Usage
+
+### Save a directory
+
+- Save the current directory or a specified directory:
+
+```bash
+twd -s [path] [alias]
+```
+
+If no path is specified, the current directory is saved. The alias is optional, and if not provided, an auto-generated ID will be used.
+
+### Go to a saved directory
+
+- Navigate to a saved directory using an optional alias:
+
+```bash
+twd -g [alias]
+```
+
+If no alias is provided, the most recently saved directory will be used. If an alias is provided, it will navigate to the directory associated with that alias.
+
+### List saved directories
+
+- Display a list of all saved directories:
+
+```bash
+twd -l
+```
+
+### Unset the TWD and delete the data file
+
+- Unset and delete the saved directories:
+
+```bash
+twd -u
+```
+
+You can force this action using the `--force` flag to avoid accidental execution.
+
+```bash
+twd -u --force
+```
+
+### Optional Parameters
+
+#### Simple Output
+
+For cleaner, minimal output intended for scripting or piping.
+
+- Example with `--simple-output`:
+
+```bash
+twd -s --simple-output
+/home/user/.config
+```
+
+- Example without `--simple-output`:
+
+```bash
+Saved TWD to /home/user/.config
+```
+
+#### No Output
+
+Suppresses all output (including confirmation messages).
+
+- Example with `--no-output`:
+
+```bash
+twd -s --no-output
+# No output
+```
+
+#### Force
+
+Use the `--force` flag to force certain actions, such as when unsetting directories with the `-u` flag.
+
+- Example:
+
+```bash
+twd -u --force
+TWD File deleted and TWD unset
+```
+
+## Contribution
+
+To set up a development environment:
+
+1. Clone the repository:
+
+```bash
+git clone https://github.com/m4sc0/twd
+cd twd
+```
+
+2. Install the package in editable mode using `pip`:
+
+```bash
+pip install -e .
+```
+
+3. Make your changes, and contribute!

{twd_m4sc0-1.5.2 → twd_m4sc0-1.5.4}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name="twd_m4sc0",
-    version="1.5.2",
+    version="1.5.4",
     packages=find_packages(),
     entry_points={
         "console_scripts": [
@@ -18,7 +18,7 @@ setup(
         "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
     ],
-    python_requires='>=3.6',
+    python_requires=">=3.6",
     long_description=open("README.md").read(),
     long_description_content_type="text/markdown",
 )

twd_m4sc0-1.5.4/twd/logger.py

@@ -0,0 +1,47 @@
+import os
+import time
+
+
+def format_message(message, config):
+    """Format the log message according to the provided config."""
+    result = config.get("log_format", "[$T]: $M")
+    result = result.replace("$T", time.strftime("%Y-%m-%d %H:%M:%S"))
+    result = result.replace("$M", message)
+    return result
+
+
+def ensure_directory_exists(file_path):
+    """Ensure the directory for the given file path exists."""
+    directory = os.path.dirname(file_path)
+    if not os.path.exists(directory):
+        os.makedirs(directory, exist_ok=True)
+
+
+def write_log(message, config):
+    """Write log message to the log file specified in the config."""
+    log_file = os.path.expanduser(config.get("log_file"))
+    log_file = os.path.abspath(log_file)
+    ensure_directory_exists(log_file)  # Ensure the directory exists
+    with open(log_file, "a+") as f:
+        f.write(message + "\n")
+
+
+def write_error(message, config):
+    """Write error message to the error file specified in the config."""
+    error_file = os.path.expanduser(config.get("error_file"))
+    error_file = os.path.abspath(error_file)
+    ensure_directory_exists(error_file)  # Ensure the directory exists
+    with open(error_file, "a+") as f:
+        f.write(message + "\n")
+
+
+def log(message, config):
+    """Log the message using the provided config."""
+    formatted_message = format_message(message, config)
+    write_log(formatted_message, config)
+
+
+def error(message, config):
+    """Log the error using the provided config."""
+    formatted_message = format_message(message, config)
+    write_error(formatted_message, config)

twd_m4sc0-1.5.4/twd/twd.py

@@ -0,0 +1,348 @@
+import os
+import argparse
+import json
+import hashlib
+import time
+import re
+from importlib.metadata import version, PackageNotFoundError
+from .logger import log, error
+
+TWD_DIR = os.path.join(os.path.expanduser("~"), ".twd")
+CONFIG_FILE = os.path.join(TWD_DIR, "config")
+
+DEFAULT_CONFIG = {
+    "data_file": os.path.expanduser("~/.twd/data"),
+    "output_behaviour": 2,
+    "log_file": os.path.expanduser("~/.twd/log"),
+    "error_file": os.path.expanduser("~/.twd/error"),
+    "log_format": "[$T]: $M",
+}
+
+# os.makedirs(TWD_DIR, exist_ok=True)
+
+
+def create_alias_id():
+    data = str(time.time()) + str(os.urandom(16))
+    return hashlib.sha256(data.encode()).hexdigest()[:12]
+
+
+def load_config():
+    if not os.path.exists(CONFIG_FILE):
+        with open(CONFIG_FILE, "w") as file:
+            json.dump(DEFAULT_CONFIG, file, indent=4)
+        return DEFAULT_CONFIG
+    else:
+        with open(CONFIG_FILE, "r") as file:
+            try:
+                return json.load(file)
+            except json.JSONDecodeError as e:
+                error(f"Error loading config: {e}", DEFAULT_CONFIG)
+                return DEFAULT_CONFIG
+
+
+CONFIG = load_config()
+
+TWD_FILE = os.path.expanduser(CONFIG.get("data_file", "~/.twd/data"))
+
+
+def ensure_data_file_exists():
+    if not os.path.exists(TWD_FILE):
+        try:
+            with open(TWD_FILE, "w") as f:
+                json.dump({}, f)
+        except OSError as e:
+            error(f"Error creating data file: {e}", CONFIG)
+
+    log_file = os.path.expanduser(CONFIG.get("log_file"))
+    error_file = os.path.expanduser(CONFIG.get("error_file"))
+
+    if not os.path.exists(log_file):
+        try:
+            with open(log_file, "w+") as f:
+                f.write("")
+        except OSError as e:
+            error(f"Error creating log file: {e}", CONFIG)
+
+    if not os.path.exists(error_file):
+        try:
+            with open(error_file, "w+") as f:
+                f.write("")
+        except OSError as e:
+            error(f"Error creating error file: {e}", CONFIG)
+
+
+ensure_data_file_exists()
+
+
+def get_absolute_path(path):
+    try:
+        return os.path.abspath(path)
+    except Exception as e:
+        error(f"Error getting absolute path for {path}: {e}", CONFIG)
+        raise
+
+
+def validate_alias(alias):
+    """Ensure the alias contains only valid characters."""
+    if not re.match(r"^[\w-]+$", alias):
+        error(f"Invalid alias provided: {alias}", CONFIG)
+        raise ValueError(
+            f"Invalid alias: '{alias}'. Aliases can only contain alphanumeric characters, dashes, and underscores."
+        )
+    return alias
+
+
+def output_handler(
+    message=None, path=None, output=True, simple_output=False, message_type=0
+):
+    log(f"Type: {message_type}, Msg: {message or path}", CONFIG)
+
+    if not output or CONFIG["output_behaviour"] == 0:
+        return
+
+    if not message and not path:
+        return
+
+    if message_type == 1:
+        print(f"1;{message}")
+    elif message_type == 0:
+        if simple_output and path:
+            print(f"0;{path}")
+        elif not simple_output and message:
+            print(f"0;{message}")
+
+
+def save_directory(path=None, alias=None, output=True, simple_output=False):
+    if path is None:
+        path = os.getcwd()
+    else:
+        path = get_absolute_path(path)
+
+    if alias:
+        alias = validate_alias(alias)
+
+    try:
+        with open(TWD_FILE, "r") as f:
+            data = json.load(f)
+    except json.JSONDecodeError as e:
+        error(f"Error reading TWD file: {e}", CONFIG)
+        data = {}
+
+    alias_id = create_alias_id()
+    data[alias_id] = {
+        "path": path,
+        "alias": alias if alias else alias_id,
+        "created_at": time.time(),
+    }
+
+    try:
+        with open(TWD_FILE, "w") as f:
+            json.dump(data, f, indent=4)
+    except OSError as e:
+        error(f"Error writing to TWD file: {e}", CONFIG)
+        raise
+
+    output_handler(
+        f"Saved TWD to {path} with alias '{alias or alias_id}'",
+        path,
+        output,
+        simple_output,
+    )
+
+
+def load_directory():
+    if not os.path.exists(TWD_FILE):
+        return None
+
+    try:
+        with open(TWD_FILE, "r") as f:
+            return json.load(f)
+    except json.JSONDecodeError as e:
+        error(f"Error loading TWD file: {e}", CONFIG)
+        return None
+
+
+def go_to_directory(alias=None, output=True, simple_output=False):
+    dirs = load_directory()
+
+    if not dirs:
+        output_handler("No TWD found", None, output, simple_output)
+        return 1
+    else:
+        for entry_id, entry in dirs.items():
+            if "alias" in entry and entry["alias"] and entry["alias"] == alias:
+                TWD = entry["path"]
+
+                if os.path.exists(TWD):
+                    output_handler(
+                        f"cd {TWD}", TWD, output, simple_output, message_type=1
+                    )
+                    return 0
+                else:
+                    error(f"Directory does not exist: {TWD}", CONFIG)
+                    output_handler(
+                        f"Directory does not exist: {TWD}", None, output, simple_output
+                    )
+                    return 1
+
+        output_handler("No TWD with alias found", None, output, simple_output)
+        return 1
+
+
+def show_directory(output=True, simple_output=False):
+    dirs = load_directory()
+
+    if not dirs:
+        output_handler("No TWD set", None, output, simple_output)
+        return
+
+    max_alias_len = max(len(entry["alias"]) for entry in dirs.values()) if dirs else 0
+    max_id_len = max(len(alias_id) for alias_id in dirs.keys()) if dirs else 0
+    max_path_len = max(len(entry["path"]) for entry in dirs.values()) if dirs else 0
+
+    header = f"{'Alias'.ljust(max_alias_len)}  {'ID'.ljust(max_id_len)}  {'Path'.ljust(max_path_len)}  Created At"
+    print(header)
+    print("-" * len(header))
+
+    for alias_id, entry in dirs.items():
+        alias = entry["alias"].ljust(max_alias_len)
+        path = entry["path"].ljust(max_path_len)
+        created_at = time.strftime(
+            "%Y-%m-%d %H:%M:%S", time.localtime(entry["created_at"])
+        )
+        alias_id_str = alias_id.ljust(max_id_len)
+        output_handler(
+            f"{alias}  {alias_id_str}  {path}  {created_at}",
+            None,
+            output,
+            simple_output,
+        )
+
+
+def unset_directory(output=True, simple_output=False, force=False):
+    if not os.path.exists(TWD_FILE):
+        output_handler(f"No TWD file found", None, output, simple_output)
+    else:
+        if not force:
+            output_handler(
+                r"""If you want to execute deleting and therefore unsetting all set TWD's, please use "--force" or "-f" and run again.
+                           
+
+This feature is to prevent accidental execution.""",
+                None,
+                True,
+                False,
+            )
+            return
+        try:
+            os.remove(TWD_FILE)
+        except OSError as e:
+            error(f"Error deleting TWD file: {e}", CONFIG)
+            raise
+        output_handler(f"TWD File deleted and TWD unset", None, output, simple_output)
+
+
+def get_package_version():
+    try:
+        return version("twd_m4sc0")
+    except PackageNotFoundError as e:
+        error(f"Package version not found: {e}", CONFIG)
+        return "Unknown version"
+
+
+def main():
+    global TWD_FILE
+
+    parser = argparse.ArgumentParser(
+        description="Temporarily save and navigate to working directories."
+    )
+
+    # Positional arguments
+    parser.add_argument("directory", nargs="?", help="Directory to save")
+    parser.add_argument(
+        "alias", nargs="?", help="Alias for the saved directory (optional)"
+    )
+
+    # Optional Arguments/Flags
+    parser.add_argument(
+        "-s",
+        "--save",
+        action="store_true",
+        help="Save the current or specified directory",
+    )
+    parser.add_argument("-d", "--dir", nargs="?", help="Directory to save")
+    parser.add_argument("-a", "--ali", nargs="?", help="Alias for the saved directory")
+    parser.add_argument(
+        "-g", "--go", nargs="?", const=None, help="Go to the saved directory"
+    )
+    parser.add_argument("-l", "--list", action="store_true", help="Show saved TWD")
+    parser.add_argument(
+        "-u", "--unset", action="store_true", help="Unset the saved TWD"
+    )
+    parser.add_argument(
+        "-v",
+        "--version",
+        action="version",
+        version=f"TWD Version: {get_package_version()}",
+        help="Show the current version of TWD installed",
+    )
+    parser.add_argument("-f", "--force", action="store_true", help="Force an action")
+    parser.add_argument(
+        "--shell", nargs="?", const="twd", help="Output shell function for integration"
+    )
+    parser.add_argument(
+        "--simple-output",
+        action="store_true",
+        help="Only print essential output (new directory, absolute path, etc.)",
+    )
+    parser.add_argument(
+        "--no-output",
+        action="store_true",
+        help="Prevents the console from sending output",
+    )
+    args = parser.parse_args()
+
+    output = not args.no_output
+    simple_output = args.simple_output
+
+    if args.shell:
+        print(rf"""
+        function {args.shell}() {{
+            output=$(python3 -m twd "$@");
+            while IFS= read -r line; do
+                if [[ -z "$line" ]]; then
+                    continue;
+                fi;
+                type=$(echo "$line" | cut -d';' -f1);
+                message=$(echo "$line" | cut -d';' -f2-);
+                if [[ "$type" == "1" ]]; then
+                    eval "$message";
+                else
+                    echo "$message";
+                fi;
+            done <<< "$output";
+        }}
+        """)
+        return 0
+
+    directory = args.directory or args.dir
+    alias = args.alias or args.ali
+
+    if args.save:
+        if not directory:
+            directory = args.directory or os.getcwd()
+
+        alias = args.alias or args.ali
+
+        save_directory(directory, alias, output, simple_output)
+    elif args.go:
+        alias = args.go
+        return go_to_directory(alias, output, simple_output)
+    elif args.list:
+        show_directory(output, simple_output)
+    elif args.unset:
+        force = args.force
+        unset_directory(output, simple_output, force)
+    else:
+        parser.print_help()
+        return 1