twd-m4sc0 2.0.3__py3-none-any.whl → 3.0.1__py3-none-any.whl

twd/twd.py

@@ -1,361 +0,0 @@
-import os
-import argparse
-import json
-import time
-import re
-import logging
-from importlib.metadata import version, PackageNotFoundError
-from .logger import initialize_logging
-from .screen import display_select
-from . import crud
-
-log = logging.getLogger("log")
-error_log = logging.getLogger("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,
-    "clear_after_screen": False,
-    "log_file": os.path.expanduser("~/.twd/log"),
-    "error_file": os.path.expanduser("~/.twd/error"),
-    "log_format": "%(asctime)s - %(levelname)s - %(message)s",
-    "log_level": "INFO",
-    "log_max_bytes": 5 * 1024 * 1024,  # 5 MB log rotation
-    "log_backup_count": 3,
-}
-
-
-def load_config():
-    if not os.path.exists(CONFIG_FILE):
-        os.makedirs(TWD_DIR, exist_ok=True)
-        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_log.error(f"Error loading config: {e}")
-                return DEFAULT_CONFIG
-
-
-CONFIG = load_config()
-initialize_logging(CONFIG)
-
-crud.ensure_data_file_exists(CONFIG)
-
-
-def ensure_log_error_files():
-    """Ensure that log and error files exist based on configuration settings."""
-    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_log.error(f"Error creating log file: {e}")
-
-    if not os.path.exists(error_file):
-        try:
-            with open(error_file, "w+") as f:
-                f.write("")
-        except OSError as e:
-            error_log.error(f"Error creating error file: {e}")
-
-
-ensure_log_error_files()
-
-
-def get_absolute_path(path):
-    try:
-        return os.path.abspath(path)
-    except Exception as e:
-        error_log.error(f"Error getting absolute path for {path}: {e}")
-        raise
-
-
-def validate_alias(alias):
-    """Ensure the alias contains only valid characters."""
-    if not re.match(r"^[\w-]+$", alias):
-        error_log.error(f"Invalid alias provided: {alias}")
-        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.info(message or path)
-
-    if CONFIG["output_behaviour"] == 1 or simple_output:
-        if path:
-            with open("/tmp/twd_path", "w") as f:
-                f.write(path)
-            if CONFIG["clear_after_screen"]:
-                with open("/tmp/twd_clear", "w") as f:
-                    f.write(path)
-            if output:
-                print(path)
-    elif CONFIG["output_behaviour"] == 2:
-        if path:
-            with open("/tmp/twd_path", "w") as f:
-                f.write(path)
-            if CONFIG["clear_after_screen"]:
-                with open("/tmp/twd_clear", "w") as f:
-                    f.write(path)
-        if output:
-            print(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)
-
-    data = crud.load_data(CONFIG)
-    alias_id = crud.create_entry(CONFIG, data, path, alias)
-
-    output_handler(
-        f"Saved TWD to {path} with alias '{alias or alias_id}'",
-        path,
-        output,
-        simple_output,
-    )
-
-
-def load_directory():
-    data = crud.load_data(CONFIG)
-    return data if data else None
-
-
-def show_main(alias=None, output=True, simple_output=False):
-    dirs = load_directory()
-    if dirs is None:
-        output_handler("No TWD found", None, output, simple_output)
-        return 1
-    else:
-        if alias:
-            matched_dirs = []
-
-            for entry_id, entry in dirs.items():
-                if (
-                    "alias" in entry
-                    and entry["alias"]
-                    and entry["alias"].startswith(alias)
-                ):
-                    entry["id"] = entry_id
-                    matched_dirs.append(entry)
-                elif entry_id.startswith(alias):
-                    entry["id"] = entry_id
-                    matched_dirs.append(entry)
-
-            if len(matched_dirs) == 1:
-                TWD = matched_dirs[0]["path"]
-                if os.path.exists(TWD):
-                    output_handler(
-                        f"cd {TWD}", TWD, output, simple_output, message_type=1
-                    )
-                    return 0
-                else:
-                    error_log.error(f"Directory does not exist: {TWD}")
-                    output_handler(
-                        f"Directory does not exist: {TWD}", None, output, simple_output
-                    )
-                    return 1
-            elif len(matched_dirs) > 1:
-                output_handler(
-                    f"Multiple TWDs match for '{alias}':", None, output, simple_output
-                )
-                for match in matched_dirs:
-                    output_handler(
-                        f"{match['alias']}  {match['id']}  {match['path']}",
-                        None,
-                        output,
-                        simple_output,
-                    )
-                return 1
-            else:
-                output_handler("No TWD with alias found", None, output, simple_output)
-                return 1
-
-        selected_dir = display_select(CONFIG, dirs)
-        if selected_dir is None:
-            output_handler("No TWD selected", None, output, simple_output)
-            return 0
-        else:
-            TWD = selected_dir["path"]
-            if os.path.exists(TWD):
-                output_handler(f"cd {TWD}", TWD, output, simple_output, message_type=1)
-                return 0
-            else:
-                error_log.error(f"Directory does not exist: {TWD}")
-                output_handler(
-                    f"Directory does not exist: {TWD}", 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 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:
-        crud.delete_data_file(CONFIG)
-    except OSError as e:
-        error_log.error(f"Error deleting TWD file: {e}")
-        raise
-    output_handler("TWD File deleted and TWD unset", None, output, simple_output)
-
-
-def setup(alias):
-    bashrc_path = os.path.expanduser("~/.bashrc")
-    alias = "twd" if not alias else alias
-    with open(bashrc_path, "a") as file:
-        file.write(f"\neval $(python3 -m twd --shell {alias})\n")
-    print("Please execute the following command to activate TWD:")
-    print("")
-    print(f"source {bashrc_path}")
-
-
-def get_package_version():
-    try:
-        return version("twd_m4sc0")
-    except PackageNotFoundError as e:
-        error_log.error(f"Package version not found: {e}")
-        return "Unknown version"
-
-
-def main():
-    parser = argparse.ArgumentParser(
-        description="Temporarily save and navigate to working directories."
-    )
-
-    parser.add_argument(
-        "--setup", nargs="?", const="twd", help="Automatic setup in the .bashrc file"
-    )
-
-    parser.add_argument("directory", nargs="?", help="Directory to save")
-    parser.add_argument(
-        "alias", nargs="?", help="Alias for the saved directory (optional)"
-    )
-    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=" ", 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: v{get_package_version()}",
-    )
-    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"
-    )
-    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}() {{
-            python3 -m twd "$@";
-            if [ -f /tmp/twd_path ]; then
-                cd "$(cat /tmp/twd_path)";
-                /bin/rm -f /tmp/twd_path;
-            fi;
-            if [ -f /tmp/twd_clear ]; then
-                clear;
-                /bin/rm -f /tmp/twd_clear;
-            fi;
-        }}""")
-        return 0
-
-    if args.setup:
-        setup(args.setup)
-        return 0
-
-    directory = args.directory or args.dir
-    alias = args.alias or args.ali
-
-    if args.save:
-        save_directory(directory, alias, output, simple_output)
-    elif args.go:
-        show_main(alias, output, simple_output)
-    elif args.list:
-        show_directory(output, simple_output)
-    elif args.unset:
-        unset_directory(output, simple_output, force=args.force)
-    else:
-        show_main(None, output, simple_output)
-
-
-if __name__ == "__main__":
-    main()

twd_m4sc0-2.0.3.dist-info/LICENSE

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

twd_m4sc0-2.0.3.dist-info/METADATA

@@ -1,179 +0,0 @@
-Metadata-Version: 2.1
-Name: twd_m4sc0
-Version: 2.0.3
-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.
-
-> All Versions `< v1.5` are considered deprecated and should not be used anymore because of the `config` file that was introduced in that version. This file is incompatible with newer versions and might cause issues or break the program.
-
-## 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.
-- Some options can be configured using the `config` file. For more information please visit the [Config](CONFIG.md) documentation.
-
-## Installation
-
-### Installation using `pip`
-
-1. Install the package from the `pypi` repository:
-
-```bash
-pip install twd-m4sc0
-```
-
-2. Ensure proper installation by checking the version
-
-```bash
-python3 -m twd -v
-```
-
-### Setup using in-built commands
-
-> This setup information is only recommend if you're system is using the `.bashrc` file provided by debian based systems and it's located at `~/.bashrc`. If you're unsure what you're shell configuration file is called or where it's located please refer to your official OS documentation to ensure proper functionality.
-
-1. Run the following command to activate the `twd` shell function
-
-> Replace `[alias]` with an alias of your choice to customize the way you're calling the script and follow the given instructions
-
-```bash
-python3 -m twd --setup [alias]
-```
-
-### Manual setup
-
-1. Add the following line to your shell configuration file:
-
-```bash
-eval $(python3 -m twd --shell [alias])
-```
-
-2. Run the following command to apply the new configuration:
-
-```bash
-source ~/.bashrc
-```
-
-or
-
-```bash
-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-2.0.3.dist-info/RECORD

@@ -1,14 +0,0 @@
-tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-tests/test_twd.py,sha256=XrxOo99oqida_7qZ48pA6BCazZekDmG5syw9NvjZWDU,484
-twd/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-twd/__main__.py,sha256=gM_Py51pQFH3CXdDIuPzBW6eNlFH1UHeRAmgAPWQyik,61
-twd/crud.py,sha256=QTruLgK9aBorJ1VKpeBS-joeD1DZbK2JfQm9tl3v5Bc,3057
-twd/logger.py,sha256=WG-JBbkdizR2KMODGcxREj1N--CgY-PdIC_agyZ5PHU,1590
-twd/screen.py,sha256=vQFNtast5-P_XrdvbY7XyIx2MGoNR7TUoVHHkXUTbvc,7066
-twd/twd.py,sha256=-YEu8JizOccuu3OeZzKecaRRelqzw-f92knG9shTJNM,11398
-twd_m4sc0-2.0.3.dist-info/LICENSE,sha256=eQSDjcD_fvOwfjmrzxKJhtZsSI39seMawuvsgeD_dfw,1062
-twd_m4sc0-2.0.3.dist-info/METADATA,sha256=FGQSzmNf6LcLOflPD7z6suetLy6-TOiw0YWy5lJryKs,4084
-twd_m4sc0-2.0.3.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
-twd_m4sc0-2.0.3.dist-info/entry_points.txt,sha256=QfYDHHjipkVN4oalpACFmIeYHb7GQCJY4SC12bTsiQQ,37
-twd_m4sc0-2.0.3.dist-info/top_level.txt,sha256=PXToru2Yr2Xh3F_F-pHXtuOQVp5x7KKCPFf94P_VI5U,10
-twd_m4sc0-2.0.3.dist-info/RECORD,,

twd_m4sc0-2.0.3.dist-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-twd = twd.twd:main

twd_m4sc0-2.0.3.dist-info/top_level.txt

@@ -1,2 +0,0 @@
-tests
-twd