twd-m4sc0 2.0.1__tar.gz → 2.0.3__tar.gz

{twd_m4sc0-2.0.1 → twd_m4sc0-2.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: twd_m4sc0
-Version: 2.0.1
+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.1 → twd_m4sc0-2.0.3}/README.md

@@ -1,9 +1,8 @@
-
 # 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
 
@@ -16,7 +15,7 @@
 
 ## Installation
 
-### Installation using `pip`:
+### Installation using `pip`
 
 1. Install the package from the `pypi` repository:
 
@@ -24,19 +23,41 @@
 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.1 → twd_m4sc0-2.0.3}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name="twd_m4sc0",
-    version="2.0.1",
+    version="2.0.3",
     packages=find_packages(),
     entry_points={
         "console_scripts": [

{twd_m4sc0-2.0.1 → twd_m4sc0-2.0.3}/twd/twd.py

@@ -18,6 +18,7 @@ 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",
@@ -92,18 +93,24 @@ def validate_alias(alias):
 def output_handler(
     message=None, path=None, output=True, simple_output=False, message_type=0
 ):
-    log.info(f"Type: {message_type}, Msg: {message or path}")
+    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)
 
@@ -248,6 +255,16 @@ This feature is to prevent accidental execution.""",
     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")
@@ -261,6 +278,10 @@ def main():
         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)"
@@ -310,9 +331,17 @@ def main():
                 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
 

{twd_m4sc0-2.0.1 → twd_m4sc0-2.0.3}/twd_m4sc0.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: twd_m4sc0
-Version: 2.0.1
+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
 ```