pyhabitat 1.0.8__py3-none-any.whl → 1.0.10__py3-none-any.whl

pyhabitat/environment.py

@@ -418,12 +418,14 @@ def is_pipx(debug=False) -> bool:
 
 
 # --- TTY CHECK ---
-def is_interactive_terminal():
+def interactive_terminal_is_available():
     """
     Check if the script is running in an interactive terminal. 
     Assumpton: 
-        If is_interactive_terminal() returns True, 
-        then typer.prompt() will work reliably.
+        If interactive_terminal_is_available() returns True, 
+        then typer.prompt() or input() will work reliably,
+        without getting lost in a log or lost entirely.
+    
     """
     # Check if a tty is attached to stdin
     return sys.stdin.isatty() and sys.stdout.isatty()

{pyhabitat-1.0.8.dist-info → pyhabitat-1.0.10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyhabitat
-Version: 1.0.8
+Version: 1.0.10
 Summary: A lightweight library for detecting system environment, GUI, and build properties.
 Author-email: George Clayton Bennett <george.bennett@memphistn.gov>
 License-Expression: MIT
@@ -25,37 +25,53 @@ Dynamic: license-file
 
 Stop writing verbose `sys.platform` and environment variable checks. Use **`pyhabitat`** to implement clean, **architectural logic** based on the execution habitat.
 
+---
+
+Read the code on [github](https://github.com/City-of-Memphis-Wastewater/pyhabitat/blob/main/pyhabitat/environment.py). 🌐
+
+---
+
+## 📦 Installation
+
+```bash
+pip install pyhabitat
+```
+
+---
+
+<details>
+<summary> 🧠 Motivation </summary>
+
 This library is especially useful for **leveraging Python in mobile environments** (`Termux` on Android and `iSH` on iOS), which often have particular limitations and require special handling. For example, it helps automate work-arounds like using **localhost plotting** when `matplotlib` is unavailable or **web-based interfaces** when `tkinter` is missing. 
 
 Our team is fundamentally driven by enabling mobile computing for true utility applications, leveraging environments like Termux (Android) and iSH (iOS). This includes highly practical solutions, such as deploying a lightweight Python web server (e.g., Flask, http.server, FastAPI) directly on a handset, or orchestrating full-stack, utility-grade applications that allow technicians to manage data and systems right from their mobile device in a way that is cross-platform and not overly catered to the App Store.
 
-Another key goal of this project is to facilitate the orchestration of wider system installation for **`pipx` CLI tools** for additional touch points, like addition to context menus and widgets.
+Another key goal of this project is to facilitate the orchestration of wider system installation for **`pipx` CLI tools** for additional touch points, like context menus and widgets.
 
 Ultimately, [City-of-Memphis-Wastewater](https://github.com/City-of-Memphis-Wastewater) aims to produce **reference-quality code** for the documented proper approach. We recognize that many people (and bots) are searching for ideal solutions, and our functions are built upon extensive research and testing to go **beyond simple `platform.system()` checks**.
 
----
-
-Read the code on [github](https://github.com/City-of-Memphis-Wastewater/pyhabitat/blob/main/pyhabitat/environment.py).
+</details>
 
 ---
 
-## 🚀 Features
+<details>
+<summary> 🚀 Features </summary>
 
   * **Definitive Environment Checks:** Rigorous checks catered to Termux and iSH (iOS Alpine). Accurate, typical modern detection for Windows, macOS (Apple), Linux, FreeBSD, Android.
   * **GUI Availability:** Rigorous, cached checks to determine if the environment supports a graphical popup window (Tkinter/Matplotlib TkAgg) or just headless image export (Matplotlib Agg).
   * **Build/Packaging Detection:** Reliable detection of standalone executables built by tools like PyInstaller, and, crucially, correct identification and exclusion of pipx-managed virtual environments, which also user binaries that could conflate the check.
   * **Executable Type Inspection:** Uses file magic numbers (ELF and MZ) to confirm if the running script is a monolithic, frozen binary (non-pipx).
 
-## 📦 Installation
-
-```bash
-pip install pyhabitat
-```
+</details>
+  
 ---
 
-## 📚 Function Reference
+<details>
+<summary> 📚 Function Reference </summary>
+
+### OS and Environment Checking
 
-### OS and Environment
+Key question: "What is this running on?"
 
 | Function | Description |
 | :--- | :--- |
@@ -66,7 +82,9 @@ pip install pyhabitat
 | `is_ish_alpine()` | Returns `True` if running in the iSH Alpine Linux iOS emulator. |
 | `is_android()` | Returns `True` on any Android-based Linux environment. |
 
-### Build and Packaging
+### Packaging and Build Checking
+
+Key question: "What is the character of my executable?"
 
 | Function | Description |
 | :--- | :--- |
@@ -76,27 +94,37 @@ pip install pyhabitat
 | `is_windows_portable_executable()` | Checks if the executable is a Windows PE binary (MZ header), excluding pipx. |
 | `is_macos_executable()` | Checks if the executable is a macOS/Darwin Mach-O binary, excluding pipx. |
 
-### Capabilities
+### Capability Checking
+
+Key Question: "What could I do next?"
 
 | Function | Description |
 | :--- | :--- |
 | `tkinter_is_available()` | Checks if Tkinter is imported and can successfully create a window. |
 | `matplotlib_is_available_for_gui_plotting(termux_has_gui=False)` | Checks for Matplotlib and its TkAgg backend, required for interactive plotting. |
 | `matplotlib_is_available_for_headless_image_export()` | Checks for Matplotlib and its Agg backend, required for saving images without a GUI. |
-| `is_interactive_terminal()` | Checks if standard input and output streams are connected to a TTY (allows safe use of interactive prompts). |
+| `interactive_terminal_is_available()` | Checks if standard input and output streams are connected to a TTY (allows safe use of interactive prompts). |
 | `web_browser_is_available()` | Check if a web browser can be launched in the current environment (allows safe use of web-based prompts and localhost plotting). 	|
 
 ### Actions
+
 | Function | Description |
 | :--- | :--- |
 | `open_text_file_in_default_app()` | Smoothly opens a text file for editing (for configuration editing prompted by a CLI flag). |
 
+</details>
+
 ---
 
-## 💻 Usage Examples
+<details>
+<summary> 💻 Usage Examples </summary>
 
 The module exposes all detection functions directly for easy access.
 
+### 0\. Current Use
+
+The `pipeline-eds` pacakge uses the `pyhabitat` library to handle [configuration](https://github.com/City-of-Memphis-Wastewater/pipeline/blob/main/src/pipeline/security_and_config.py) and [plotting](https://github.com/City-of-Memphis-Wastewater/pipeline/blob/main/src/pipeline/cli.py), among other things.
+
 ### 1\. Checking Environment and Build Type
 
 ```python
@@ -125,7 +153,7 @@ elif is_windows():
 Use these functions to determine if you can show an interactive plot or if you must save an image file.
 
 ```python
-from pyhabitat import matplotlib_is_available_for_gui_plotting, matplotlib_is_available_for_headless_image_export
+from pyhabitat import matplotlib_is_available_for_gui_plotting, matplotlib_is_available_for_headless_image_export, 
 
 if matplotlib_is_available_for_gui_plotting():
     # We can safely call plt.show()
@@ -151,6 +179,8 @@ Ideal use case: Edit a configuration file, if prompted by a CLI command like 'co
 ```python
 open_text_file_in_default_app(filepath=Path('./config.json'))
 ```
+</details>
+
 ---
 
 ## 🤝 Contributing

pyhabitat-1.0.10.dist-info/RECORD

@@ -0,0 +1,7 @@
+pyhabitat/__init__.py,sha256=fy1SRFXok05bCprjGMCXS5afw27iKBJCLeSQTuBjlRI,1101
+pyhabitat/environment.py,sha256=rteFLXko5VaxwgfQYRR7SBQaRygKqrNr0YjRYQ5mybo,18206
+pyhabitat-1.0.10.dist-info/licenses/LICENSE,sha256=D4fg30ctUGnCJlWu3ONv5-V8JE1v3ctakoJTcVjsJlg,1072
+pyhabitat-1.0.10.dist-info/METADATA,sha256=NgnZUKS9GsVT9e_sKbhzekLes5jrPTSMnvY5LhNfrnc,8819
+pyhabitat-1.0.10.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pyhabitat-1.0.10.dist-info/top_level.txt,sha256=zXYK44Qu8EqxUETREvd2diMUaB5JiGRErkwFaoLQnnI,10
+pyhabitat-1.0.10.dist-info/RECORD,,

pyhabitat-1.0.8.dist-info/RECORD

@@ -1,7 +0,0 @@
-pyhabitat/__init__.py,sha256=fy1SRFXok05bCprjGMCXS5afw27iKBJCLeSQTuBjlRI,1101
-pyhabitat/environment.py,sha256=eGF6BSTNEnbit6RNVhG6JPqckhhnGlYE3vukq_GRPSk,18114
-pyhabitat-1.0.8.dist-info/licenses/LICENSE,sha256=D4fg30ctUGnCJlWu3ONv5-V8JE1v3ctakoJTcVjsJlg,1072
-pyhabitat-1.0.8.dist-info/METADATA,sha256=JMok0YO4zDc0rRa7yEgqrkjfT6m33wmqGwmTJweJsvg,8128
-pyhabitat-1.0.8.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pyhabitat-1.0.8.dist-info/top_level.txt,sha256=zXYK44Qu8EqxUETREvd2diMUaB5JiGRErkwFaoLQnnI,10
-pyhabitat-1.0.8.dist-info/RECORD,,