nercone-shell 0.2.6__tar.gz → 0.2.8__tar.gz

{nercone_shell-0.2.6 → nercone_shell-0.2.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: nercone-shell
-Version: 0.2.6
+Version: 0.2.8
 Summary: Modern shell for Developers
 Author: Nercone
 Author-email: Nercone <nercone@diamondgotcat.net>
@@ -60,3 +60,35 @@ pip3 install nercone-shell --upgrade --break-system-packages
 ```
 pip3 install nercone-shell --upgrade
 ```
+
+## Configuration
+The configuration file is usually located at `~/.nercone/nercone-shell/config.json`.
+If the file does not exist when Nersh starts, it will be automatically created.
+
+The following is the default configuration file:
+```
+{
+    "customization": {
+        "show_version": true,
+        "override_env": {
+            "SHELL": "None"
+        },
+        "autoruns": [
+            "<path to home directory>/.nercone/nercone-shell/autostart.sh"
+        ]
+    },
+    "compatibility": {
+        "report_invisible_characters": false
+    }
+}
+```
+
+### Customization
+These settings customize the behavior of Nersh.
+- `show_version`: Sets whether to display version information at startup.
+- `override_env`: Sets the environment variables you want to set at startup in dictionary format.
+- `autoruns`: Sets the shell scripts you want to run at startup in array format.
+
+### Compatibility
+This setting allows Nersh to function properly in special environments.
+- `report_invisible_characters`: A Boolean value that enables reporting of invisible characters to readline, which is necessary in some environments, such as Linux without a GUI (TUI only).

nercone_shell-0.2.8/README.md

@@ -0,0 +1,80 @@
+
+<img width="1710" alt="Screenshot" src="https://github.com/user-attachments/assets/a717ebd3-c9d4-447c-86a5-7d33eea9c028" />
+
+# Nersh (Nercone Shell)
+Modern shell for Developers
+
+## Requiments
+- CPython 3.9+
+- `uv` [PyPI↗︎](https://pypi.org/project/uv/) or `pip3` [PyPI↗︎](https://pypi.org/project/pip/) 
+- `nercone-modern` [PyPI↗︎](https://pypi.org/project/nercone-modern/)
+
+## Installation
+
+### using uv (recommended)
+```
+uv tool install nercone-shell
+```
+
+### using pip3
+
+**System Python:**
+```
+pip3 install nercone-shell --break-system-packages
+```
+
+**Venv Python:**
+```
+pip3 install nercone-shell
+```
+
+## Update
+
+### using uv (recommended)
+```
+uv tool install nercone-shell --upgrade
+```
+
+### using pip3
+
+**System Python:**
+```
+pip3 install nercone-shell --upgrade --break-system-packages
+```
+
+**Venv Python:**
+```
+pip3 install nercone-shell --upgrade
+```
+
+## Configuration
+The configuration file is usually located at `~/.nercone/nercone-shell/config.json`.
+If the file does not exist when Nersh starts, it will be automatically created.
+
+The following is the default configuration file:
+```
+{
+    "customization": {
+        "show_version": true,
+        "override_env": {
+            "SHELL": "None"
+        },
+        "autoruns": [
+            "<path to home directory>/.nercone/nercone-shell/autostart.sh"
+        ]
+    },
+    "compatibility": {
+        "report_invisible_characters": false
+    }
+}
+```
+
+### Customization
+These settings customize the behavior of Nersh.
+- `show_version`: Sets whether to display version information at startup.
+- `override_env`: Sets the environment variables you want to set at startup in dictionary format.
+- `autoruns`: Sets the shell scripts you want to run at startup in array format.
+
+### Compatibility
+This setting allows Nersh to function properly in special environments.
+- `report_invisible_characters`: A Boolean value that enables reporting of invisible characters to readline, which is necessary in some environments, such as Linux without a GUI (TUI only).

{nercone_shell-0.2.6 → nercone_shell-0.2.8}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "nercone-shell"
-version = "0.2.6"
+version = "0.2.8"
 description = "Modern shell for Developers"
 readme = { file = "README.md", content-type = "text/markdown" }
 authors = [

{nercone_shell-0.2.6 → nercone_shell-0.2.8}/src/nercone_shell/__main__.py

@@ -30,13 +30,18 @@ NERSH_HISTORY_PATH = Path(os.environ.get("NERSH_HISTORY_PATH", str(Path(NERSH_PA
 NERSH_CONFIG: dict = {}
 NERSH_CONFIG_PATH = Path(os.environ.get("NERSH_CONFIG_PATH", str(Path(NERSH_PATH, "config.json"))))
 NERSH_CONFIG_DEFAULT: dict = {
-    "show_version": True,
-    "override_env": {
-        "SHELL": f"{shutil.which('nersh')}"
+    "customization": {
+        "show_version": True,
+        "override_env": {
+            "SHELL": f"{shutil.which('nersh')}"
+        },
+        "autoruns": [
+            f"{Path(NERSH_PATH, 'autostart.sh')}"
+        ]
     },
-    "autoruns": [
-        f"{Path(NERSH_PATH, 'autostart.sh')}"
-    ]
+    "compatibility": {
+        "report_invisible_characters": False
+    }
 }
 
 class NershCompleter:
@@ -158,8 +163,10 @@ def reset():
 def reload():
     global ENVIRONMENT
     load_config()
+    pwd = ENVIRONMENT.get("PWD")
     ENVIRONMENT |= os.environ
-    ENVIRONMENT |= NERSH_CONFIG.get("override_env", {})
+    ENVIRONMENT |= {"PWD": pwd}
+    ENVIRONMENT |= NERSH_CONFIG.get("customization", {}).get("override_env", {})
 
 def load_config() -> dict:
     global NERSH_CONFIG
@@ -169,7 +176,7 @@ def load_config() -> dict:
             f.write(json.dumps(NERSH_CONFIG_DEFAULT, indent=4) + "\n")
     with NERSH_CONFIG_PATH.open("r") as f:
         NERSH_CONFIG |= json.loads(f.read())
-    for p in NERSH_CONFIG.get("autoruns", []):
+    for p in NERSH_CONFIG.get("customization", {}).get("autoruns", []):
         if not Path(p).is_file():
             with Path(p).open("w") as f:
                 f.write("\n")
@@ -261,9 +268,9 @@ def main() -> int:
     else:
         readline.parse_and_bind("tab: complete")
     readline.set_completer_delims(' \t\n;')
-    if NERSH_CONFIG.get("show_version", True):
+    if NERSH_CONFIG.get("customization", {}).get("show_version", True):
         show_version()
-    for p in NERSH_CONFIG.get("autoruns", []):
+    for p in NERSH_CONFIG.get("customization", {}).get("autoruns", []):
         if Path(p).is_file():
             with Path(p).open("r") as f:
                 run_script(f.read())
@@ -275,13 +282,13 @@ def main() -> int:
         run_script(NERSH_AUTORUN)
     if NERSH_HISTORY_PATH.is_file():
         readline.read_history_file(NERSH_HISTORY_PATH)
-    RL_PROMPT_START_IGNORE = '\001'
-    RL_PROMPT_END_IGNORE = '\002'
-    green = f"{RL_PROMPT_START_IGNORE}{ModernColor.color('green')}{RL_PROMPT_END_IGNORE}"
-    reset = f"{RL_PROMPT_START_IGNORE}{ModernColor.color('reset')}{RL_PROMPT_END_IGNORE}"
+    RL_PROMPT_START_IGNORE = "\001" if NERSH_CONFIG.get("compatibility", {}).get("report_invisible_characters", False) else ""
+    RL_PROMPT_END_IGNORE = "\002" if NERSH_CONFIG.get("compatibility", {}).get("report_invisible_characters", False) else ""
+    color_green = f"{RL_PROMPT_START_IGNORE}{ModernColor.color('green')}{RL_PROMPT_END_IGNORE}"
+    color_reset = f"{RL_PROMPT_START_IGNORE}{ModernColor.color('reset')}{RL_PROMPT_END_IGNORE}"
     while True:
         try:
-            run_line(input(f"{green}{getpass.getuser()}{reset}@{os.uname()[1].rsplit('.', 1)[0]} {green}{shorten_path(ENVIRONMENT.get('PWD', f'{Path('~').expanduser()}'))}{reset}> "))
+            run_line(input(f"{color_green}{getpass.getuser()}{color_reset}@{os.uname()[1].rsplit('.', 1)[0]} {color_green}{shorten_path(ENVIRONMENT.get('PWD', f'{Path('~').expanduser()}'))}{color_reset}> "))
         except KeyboardInterrupt:
             print()
             continue

nercone_shell-0.2.6/README.md

@@ -1,48 +0,0 @@
-
-<img width="1710" alt="Screenshot" src="https://github.com/user-attachments/assets/a717ebd3-c9d4-447c-86a5-7d33eea9c028" />
-
-# Nersh (Nercone Shell)
-Modern shell for Developers
-
-## Requiments
-- CPython 3.9+
-- `uv` [PyPI↗︎](https://pypi.org/project/uv/) or `pip3` [PyPI↗︎](https://pypi.org/project/pip/) 
-- `nercone-modern` [PyPI↗︎](https://pypi.org/project/nercone-modern/)
-
-## Installation
-
-### using uv (recommended)
-```
-uv tool install nercone-shell
-```
-
-### using pip3
-
-**System Python:**
-```
-pip3 install nercone-shell --break-system-packages
-```
-
-**Venv Python:**
-```
-pip3 install nercone-shell
-```
-
-## Update
-
-### using uv (recommended)
-```
-uv tool install nercone-shell --upgrade
-```
-
-### using pip3
-
-**System Python:**
-```
-pip3 install nercone-shell --upgrade --break-system-packages
-```
-
-**Venv Python:**
-```
-pip3 install nercone-shell --upgrade
-```