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

twd/crud.py

@@ -2,9 +2,12 @@ import os
 import json
 import hashlib
 import time
-from .logger import log, error
+import logging
 from collections import OrderedDict
 
+log = logging.getLogger("log")
+error_log = logging.getLogger("error")
+
 
 def create_alias_id():
     data = str(time.time()) + str(os.urandom(16))
@@ -21,8 +24,9 @@ def ensure_data_file_exists(config):
         try:
             with open(data_file, "w") as f:
                 json.dump({}, f)
+            log.info(f"Created data file at {data_file}")
         except OSError as e:
-            error(f"Error creating data file: {e}", config)
+            error_log.error(f"Error creating data file: {e}")
 
 
 def load_data(config):
@@ -32,12 +36,13 @@ def load_data(config):
     try:
         with open(data_file, "r") as f:
             data = json.load(f)
+            log.info(f"Loaded data from {data_file}")
             return data
     except json.JSONDecodeError as e:
-        error(f"Error reading data file: {e}", config)
+        error_log.error(f"Error reading data file: {e}")
         return {}
     except OSError as e:
-        error(f"Error reading data file: {e}", config)
+        error_log.error(f"Error reading data file: {e}")
         return {}
 
 
@@ -49,8 +54,9 @@ def save_data(config, data):
         )
         with open(data_file, "w") as f:
             json.dump(sorted_data, f, indent=4)
+        log.info(f"Saved data to {data_file}")
     except OSError as e:
-        error(f"Error writing to data file: {e}", config)
+        error_log.error(f"Error writing to data file: {e}")
 
 
 def create_entry(config, data, path, alias=None):
@@ -61,6 +67,7 @@ def create_entry(config, data, path, alias=None):
         "created_at": time.time(),
     }
     save_data(config, data)
+    log.info(f"Created new entry with alias_id '{alias_id}' and path '{path}'")
     return alias_id
 
 
@@ -68,8 +75,9 @@ def delete_entry(config, data, entry_id):
     if entry_id in data:
         del data[entry_id]
         save_data(config, data)
+        log.info(f"Deleted entry with alias_id '{entry_id}'")
     else:
-        error(f"Entry ID {entry_id} not found", config)
+        error_log.error(f"Entry ID '{entry_id}' not found")
         raise KeyError(f"Entry ID {entry_id} not found")
 
 
@@ -77,8 +85,9 @@ def update_entry(config, data, entry_id, entry):
     if entry_id in data:
         data[entry_id] = entry
         save_data(config, data)
+        log.info(f"Updated entry with alias_id '{entry_id}'")
     else:
-        error(f"Entry ID {entry_id} not found", config)
+        error_log.error(f"Entry ID '{entry_id}' not found")
         raise KeyError(f"Entry ID {entry_id} not found")
 
 
@@ -87,8 +96,9 @@ def delete_data_file(config):
     if os.path.exists(data_file):
         try:
             os.remove(data_file)
+            log.info(f"Deleted data file at {data_file}")
         except OSError as e:
-            error(f"Error deleting data file: {e}", config)
+            error_log.error(f"Error deleting data file: {e}")
             raise
     else:
-        error("No data file found to delete", config)
+        error_log.error("No data file found to delete")

twd/logger.py

@@ -1,47 +1,47 @@
+import logging
 import os
-import time
+from logging.handlers import RotatingFileHandler
 
 
-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."""
+def setup_logger(config):
+    """Set up loggers based on the configuration provided."""
     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)
-
+    log_level = config.get("log_level", "INFO").upper()
+    max_bytes = config.get("log_max_bytes", 5 * 1024 * 1024)  # Default 5MB
+    backup_count = config.get("log_backup_count", 3)  # Default 3 backup files
+
+    os.makedirs(os.path.dirname(log_file), exist_ok=True)
+    os.makedirs(os.path.dirname(error_file), exist_ok=True)
+
+    # General log configuration
+    log_formatter = logging.Formatter(
+        config.get("log_format", "%(asctime)s - %(levelname)s - %(message)s")
+    )
+
+    # Avoid duplicate handlers
+    logger = logging.getLogger("log")
+    if not logger.hasHandlers():
+        logger.setLevel(log_level)
+        log_handler = RotatingFileHandler(
+            log_file, maxBytes=max_bytes, backupCount=backup_count
+        )
+        log_handler.setFormatter(log_formatter)
+        logger.addHandler(log_handler)
+
+    # Error log configuration
+    error_logger = logging.getLogger("error")
+    if not error_logger.hasHandlers():
+        error_logger.setLevel(logging.ERROR)
+        error_handler = RotatingFileHandler(
+            error_file, maxBytes=max_bytes, backupCount=backup_count
+        )
+        error_handler.setFormatter(log_formatter)
+        error_logger.addHandler(error_handler)
+
+    return logger, error_logger
+
+
+def initialize_logging(config):
+    setup_logger(config)
 
-def error(message, config):
-    """Log the error using the provided config."""
-    formatted_message = format_message(message, config)
-    write_error(formatted_message, config)

twd/screen.py

@@ -2,7 +2,10 @@ import curses
 import time
 import os
 from . import crud
-from .logger import error
+import logging
+
+log = logging.getLogger("log")
+error_log = logging.getLogger("error")
 
 CONFIG = None
 DIRS = None
@@ -163,7 +166,7 @@ def display_select_screen(stdscr):
                 try:
                     crud.delete_entry(CONFIG, data, selected_entry_id)
                 except KeyError:
-                    error(f"Entry ID {selected_entry_id} not found", CONFIG)
+                    error_log.error(f"Entry ID {selected_entry_id} not found")
                 del filtered_DIRS[selected_entry_id]
                 if selected_entry >= len(filtered_DIRS):
                     selected_entry = max(len(filtered_DIRS) - 1, 0)
@@ -196,4 +199,3 @@ def display_select(config, dirs):
     original_DIRS = DIRS
     search_query = ""
     return curses.wrapper(display_select_screen)
-

twd/twd.py

@@ -3,20 +3,28 @@ import argparse
 import json
 import time
 import re
+import logging
 from importlib.metadata import version, PackageNotFoundError
-from .logger import log, error
+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": "[$T]: $M",
+    "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,
 }
 
 
@@ -31,32 +39,34 @@ def load_config():
             try:
                 return json.load(file)
             except json.JSONDecodeError as e:
-                error(f"Error loading config: {e}", DEFAULT_CONFIG)
+                error_log.error(f"Error loading config: {e}")
                 return DEFAULT_CONFIG
 
 
 CONFIG = load_config()
+initialize_logging(CONFIG)
 
-# Ensure data files exist
 crud.ensure_data_file_exists(CONFIG)
-log_file = os.path.expanduser(CONFIG.get("log_file"))
-error_file = os.path.expanduser(CONFIG.get("error_file"))
 
 
 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(f"Error creating log file: {e}", CONFIG)
+            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(f"Error creating error file: {e}", CONFIG)
+            error_log.error(f"Error creating error file: {e}")
 
 
 ensure_log_error_files()
@@ -66,14 +76,14 @@ 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)
+        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(f"Invalid alias provided: {alias}", CONFIG)
+        error_log.error(f"Invalid alias provided: {alias}")
         raise ValueError(
             f"Invalid alias: '{alias}'. Aliases can only contain alphanumeric characters, dashes, and underscores."
         )
@@ -83,18 +93,24 @@ def validate_alias(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)
+    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)
 
@@ -126,12 +142,10 @@ def load_directory():
 
 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:
-        # Use alias if provided
         if alias:
             matched_dirs = []
 
@@ -149,14 +163,13 @@ def show_main(alias=None, output=True, simple_output=False):
 
             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(f"Directory does not exist: {TWD}", CONFIG)
+                    error_log.error(f"Directory does not exist: {TWD}")
                     output_handler(
                         f"Directory does not exist: {TWD}", None, output, simple_output
                     )
@@ -177,19 +190,17 @@ def show_main(alias=None, output=True, simple_output=False):
                 output_handler("No TWD with alias found", None, output, simple_output)
                 return 1
 
-        # Display selection using curses if alias is not given
         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(f"Directory does not exist: {TWD}", CONFIG)
+                error_log.error(f"Directory does not exist: {TWD}")
                 output_handler(
                     f"Directory does not exist: {TWD}", None, output, simple_output
                 )
@@ -198,7 +209,6 @@ def show_main(alias=None, output=True, simple_output=False):
 
 def show_directory(output=True, simple_output=False):
     dirs = load_directory()
-
     if not dirs:
         output_handler("No TWD set", None, output, simple_output)
         return
@@ -240,16 +250,26 @@ This feature is to prevent accidental execution.""",
     try:
         crud.delete_data_file(CONFIG)
     except OSError as e:
-        error(f"Error deleting TWD file: {e}", CONFIG)
+        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(f"Package version not found: {e}", CONFIG)
+        error_log.error(f"Package version not found: {e}")
         return "Unknown version"
 
 
@@ -258,13 +278,14 @@ def main():
         description="Temporarily save and navigate to working directories."
     )
 
-    # Positional arguments
+    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)"
     )
-
-    # Optional Arguments/Flags
     parser.add_argument(
         "-s",
         "--save",
@@ -285,63 +306,56 @@ def main():
         "--version",
         action="version",
         version=f"TWD Version: v{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.)",
+        "--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()
 
+    args = parser.parse_args()
     output = not args.no_output
     simple_output = args.simple_output
 
-    # Shell function
     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
-}}
-""")
+        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:
-        if not directory:
-            directory = os.getcwd()
-
-        alias = args.alias or args.ali
-
         save_directory(directory, alias, output, simple_output)
     elif args.go:
-        alias = args.go
-        return show_main(alias, output, simple_output)
+        show_main(alias, output, simple_output)
     elif args.list:
         show_directory(output, simple_output)
     elif args.unset:
-        force = args.force
-        unset_directory(output, simple_output, force)
+        unset_directory(output, simple_output, force=args.force)
     else:
         show_main(None, output, simple_output)
-        return 1
 
 
 if __name__ == "__main__":
     main()
-

{twd_m4sc0-2.0.0.dist-info → twd_m4sc0-2.0.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: twd_m4sc0
-Version: 2.0.0
+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
@@ -11,12 +11,11 @@ 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. 
+> 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
 
@@ -29,7 +28,7 @@ License-File: LICENSE
 
 ## Installation
 
-### Installation using `pip`:
+### Installation using `pip`
 
 1. Install the package from the `pypi` repository:
 
@@ -37,19 +36,41 @@ License-File: LICENSE
 pip install twd-m4sc0
 ```
 
-2. Add the following line to your `.bashrc` or `.zshrc` to set up the shell function:
+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
 
-> 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
+1. Add the following line to your shell configuration file:
 
 ```bash
 eval $(python3 -m twd --shell [alias])
 ```
 
-3. Exit and reopen the terminal or reload using:
+2. Run the following command to apply the new configuration:
 
 ```bash
 source ~/.bashrc
-# or
+```
+
+or
+
+```bash
 source ~/.zshrc
 ```
 

twd_m4sc0-2.0.3.dist-info/RECORD

@@ -0,0 +1,14 @@
+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.0.dist-info → twd_m4sc0-2.0.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.2.0)
+Generator: setuptools (75.3.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

twd_m4sc0-2.0.0.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=pp5QPt1NEC5Hxc-O5foqgjVnQnek7jUohW15bOOoJ98,2561
-twd/logger.py,sha256=Pmhh4sOB-HyJAVBSwiESGRJElJoJ4Anhn-HVF8vxXzY,1595
-twd/screen.py,sha256=X3531u1MysSwyqmmPWZUkkU-0PSOJowz319h6cr9vrA,7005
-twd/twd.py,sha256=NS0-2Lbs1v4keG2itfxb2b5vYhpvEfmt2xPV9CdORE4,10563
-twd_m4sc0-2.0.0.dist-info/LICENSE,sha256=eQSDjcD_fvOwfjmrzxKJhtZsSI39seMawuvsgeD_dfw,1062
-twd_m4sc0-2.0.0.dist-info/METADATA,sha256=D0McQXnvy5PS_hLCRAARbn_8z7mq3YgoZrA9pA5UF3E,3528
-twd_m4sc0-2.0.0.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
-twd_m4sc0-2.0.0.dist-info/entry_points.txt,sha256=QfYDHHjipkVN4oalpACFmIeYHb7GQCJY4SC12bTsiQQ,37
-twd_m4sc0-2.0.0.dist-info/top_level.txt,sha256=PXToru2Yr2Xh3F_F-pHXtuOQVp5x7KKCPFf94P_VI5U,10
-twd_m4sc0-2.0.0.dist-info/RECORD,,