twd-m4sc0 1.1.0__py3-none-any.whl → 1.2.1__py3-none-any.whl

twd/twd.py

@@ -8,7 +8,23 @@ TWD_FILE = os.path.join(os.path.expanduser("~"), ".twd")
 def get_absolute_path(path):
     return os.path.abspath(path)
 
-def save_directory(path=None):
+def output_handler(message=None, path=None, output=True, simple_output=False):
+    """
+    Handles all output based on the flags --no-output and --simple-output.
+    - message: Regular output string
+    - path: Path to be printed (in simple output mode)
+    - output: Whether output is enabled
+    - simple_output: Whether only essential output should be shown
+    """
+    if not output:
+        return
+
+    if simple_output and path:
+        print(path)
+    elif not simple_output and message:
+        print(message)
+
+def save_directory(path=None, output=True, simple_output=False):
     if path is None:
         path = os.getcwd()
     else:
@@ -17,36 +33,36 @@ def save_directory(path=None):
     with open(TWD_FILE, "w") as f:
         f.write(path)
 
-    print(f"Saved TWD to {path}")
+    output_handler(f"Saved TWD to {path}", path, output, simple_output)
 
 def load_directory():
     if not os.path.exists(TWD_FILE):
         return None
-    
+
     with open(TWD_FILE, "r") as f:
         return f.read().strip()
 
-def go_to_directory():
+def go_to_directory(output=True, simple_output=False):
     TWD = load_directory()
-    
+
     if TWD is None:
-        print("No TWD found")
+        output_handler("No TWD found", None, output, simple_output)
         return 1
     else:
         if os.path.exists(TWD):
-            print(f"cd {TWD}")
+            output_handler(f"cd {TWD}", TWD, output, simple_output)
             return 0
         else:
-            print(f"Directory does not exist: {TWD}")
+            output_handler(f"Directory does not exist: {TWD}", None, output, simple_output)
             return 1
 
-def show_directory():
+def show_directory(output=True, simple_output=False):
     TWD = load_directory()
-    
+
     if TWD is None:
-        print("No TWD set")
+        output_handler("No TWD set", None, output, simple_output)
     else:
-        print(f"Current TWD: {TWD}")
+        output_handler(f"Current TWD: {TWD}", TWD, output, simple_output)
 
 def get_package_version():
     try:
@@ -56,22 +72,27 @@ def get_package_version():
 
 def main():
     parser = argparse.ArgumentParser(description="Temporarily save and navigate to working directories.")
-    
+
     parser.add_argument('-s', '--save', nargs='?', const='', help="Save the current or specified directory")
     parser.add_argument('-g', '--go', action='store_true', help="Go to the saved directory")
     parser.add_argument('-l', '--list', action='store_true', help="Show saved TWD")
-    parser.add_argument('--shell', action='store_true', help="Output shell function for integration")
     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('--shell', action='store_true', 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('''
         function twd() {
             output=$(python3 -m twd "$@")
             if [[ "$1" == "-g" ]]; then
                 eval "$output"
-            else {
+            else
                 echo "$output"
             fi
         }
@@ -79,11 +100,11 @@ def main():
         return 0
 
     if args.save is not None:
-        save_directory(args.save if args.save else None)
+        save_directory(args.save if args.save else None, output, simple_output)
     elif args.go:
-        return go_to_directory()
+        return go_to_directory(output, simple_output)
     elif args.list:
-        show_directory()
+        show_directory(output, simple_output)
     else:
         parser.print_help()
         return 1

twd_m4sc0-1.2.1.dist-info/METADATA

@@ -0,0 +1,122 @@
+Metadata-Version: 2.1
+Name: twd_m4sc0
+Version: 1.2.1
+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 all users who frequently need to switch between directories in the terminal.
+
+## Features
+
+- Save the current working directory.
+- Go back to the saved directory.
+- List the saved directory.
+- 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:
+
+```bash
+eval $(twd --shell)
+```
+
+3. Exit and reopen the terminal or reload using:
+
+```bash
+source ~/.bashrc
+# or
+source ~/.zshrc
+```
+
+## Usage
+
+- Save a directory
+
+```bash
+twd -s [path]
+```
+
+- Go to the saved directory
+
+```bash
+twd -g
+```
+
+- List the saved directory
+
+```bash
+twd -l
+```
+
+### Optional Parameters
+
+#### Simple Output
+
+Simpler output is meant to be for script or grep usage
+
+- Example with simple-output
+
+```bash
+user:~/.config $ twd -s --simple-output
+/home/user/.config
+```
+
+- Example without simple-output
+
+```bash
+user:~/.config $ twd -s
+Saved TWD to /home/user/.config
+```
+
+#### No Output
+
+No output is meant for just no output (impressive ik)
+
+- Example with no-output
+
+```bash
+user:~/.config $ twd -s --no-output
+# no output
+```
+
+- Example without no-output
+
+```bash
+user:~/.config $ twd -s
+Saved TWD to /home/user/.config
+```
+
+# Contribution
+
+To set up a dev environment:
+
+1. Clone the repo:
+
+```bash
+git clone https://github.com/m4sc0/twd
+cd twd
+```
+
+2. Install the package in editable mode using `pip`:
+
+```bash
+pip install -e .
+```

twd_m4sc0-1.2.1.dist-info/RECORD

@@ -0,0 +1,11 @@
+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/twd.py,sha256=iFJhVhToU2Y7AJLSi6V57xsIvZUzRK1odRBpbrbM-Rk,3669
+twd_m4sc0-1.2.1.dist-info/LICENSE,sha256=eQSDjcD_fvOwfjmrzxKJhtZsSI39seMawuvsgeD_dfw,1062
+twd_m4sc0-1.2.1.dist-info/METADATA,sha256=ian4S9D3iTTXvvZnbTGoY2mqlgrgpZjUaXR4BMIMH6Y,2109
+twd_m4sc0-1.2.1.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+twd_m4sc0-1.2.1.dist-info/entry_points.txt,sha256=QfYDHHjipkVN4oalpACFmIeYHb7GQCJY4SC12bTsiQQ,37
+twd_m4sc0-1.2.1.dist-info/top_level.txt,sha256=PXToru2Yr2Xh3F_F-pHXtuOQVp5x7KKCPFf94P_VI5U,10
+twd_m4sc0-1.2.1.dist-info/RECORD,,

twd_m4sc0-1.1.0.dist-info/METADATA

@@ -1,13 +0,0 @@
-Metadata-Version: 2.1
-Name: twd_m4sc0
-Version: 1.1.0
-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-1.1.0.dist-info/RECORD

@@ -1,11 +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/twd.py,sha256=5Xx8uot7-blhjxhJi9VvByrkg5P19Pwj_099yoQzJRM,2461
-twd_m4sc0-1.1.0.dist-info/LICENSE,sha256=eQSDjcD_fvOwfjmrzxKJhtZsSI39seMawuvsgeD_dfw,1062
-twd_m4sc0-1.1.0.dist-info/METADATA,sha256=IQiREj5PxX8J4MQd8UNWRP6QGn3ZRJNYqsRk2IAykLA,405
-twd_m4sc0-1.1.0.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-twd_m4sc0-1.1.0.dist-info/entry_points.txt,sha256=QfYDHHjipkVN4oalpACFmIeYHb7GQCJY4SC12bTsiQQ,37
-twd_m4sc0-1.1.0.dist-info/top_level.txt,sha256=PXToru2Yr2Xh3F_F-pHXtuOQVp5x7KKCPFf94P_VI5U,10
-twd_m4sc0-1.1.0.dist-info/RECORD,,