sshplex 1.0.0__tar.gz

sshplex-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

sshplex-1.0.0/MANIFEST.in

@@ -0,0 +1,9 @@
+include README.md
+include LICENSE
+include requirements.txt
+include requirements-dev.txt
+recursive-include sshplex *.py
+recursive-include sshplex *.yaml
+recursive-include sshplex *.yml
+recursive-exclude sshplex __pycache__
+recursive-exclude sshplex *.pyc

sshplex-1.0.0/PKG-INFO

@@ -0,0 +1,321 @@
+Metadata-Version: 2.4
+Name: sshplex
+Version: 1.0.0
+Summary: Multiplex your SSH connections with style
+Author-email: MJAHED Sabri <contact@sabrimjahed.com>
+License: MIT
+Project-URL: Homepage, https://github.com/sabrimjd/sshplex
+Project-URL: Repository, https://github.com/sabrimjd/sshplex
+Project-URL: Documentation, https://github.com/sabrimjd/sshplex#readme
+Project-URL: Bug Tracker, https://github.com/sabrimjd/sshplex/issues
+Keywords: ssh,tmux,multiplexer,netbox,tui,terminal
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: System :: Networking
+Classifier: Topic :: System :: Systems Administration
+Classifier: Topic :: Terminals
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pynetbox==7.3.3
+Requires-Dist: textual==0.47.1
+Requires-Dist: pyyaml==6.0.1
+Requires-Dist: pydantic==2.5.0
+Requires-Dist: loguru==0.7.2
+Requires-Dist: rich==13.7.0
+Requires-Dist: libtmux==0.25.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=22.0.0; extra == "dev"
+Requires-Dist: flake8>=5.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: types-PyYAML>=6.0.0; extra == "dev"
+Dynamic: license-file
+
+# SSHplex
+
+**Multiplex your SSH connections with style**
+
+SSHplex is a Python-based SSH connection multiplexer that provides a modern Terminal User Interface (TUI) for selecting and connecting to multiple hosts simultaneously using tmux. Built with simplicity and extensibility in mind, SSHplex integrates with NetBox as a Source of Truth and creates organized tmux sessions for efficient multi-host management.
+
+## ⚠️ Development Status
+
+**SSHplex is currently in early development phase.** While the core functionality is working, this project is actively being developed and may have breaking changes between versions. Use at your own discretion in production environments.
+
+## ✨ Features
+
+### Current Features
+- 🎯 **Interactive Host Selection**: Modern TUI built with Textual for intuitive host selection
+- 🔗 **NetBox Integration**: Automatic host discovery from NetBox with configurable filters
+- 🖥️ **tmux Integration**: Creates organized tmux sessions with panes or windows for each host
+- ⚙️ **Flexible Configuration**: YAML-based configuration with automatic setup on first run
+- 📁 **XDG Compliance**: Configuration stored in `~/.config/sshplex/` by default
+- 🔧 **Multiple Layout Options**: Support for tiled, horizontal, and vertical tmux layouts
+- 📊 **Broadcasting Support**: Sync input across multiple SSH connections (optional)
+- 🎨 **Rich Terminal Output**: Beautiful, colored output with optional logging
+- 🔍 **Host Filtering**: Search and filter hosts in the TUI interface
+- ✅ **SSH Key Authentication**: Secure key-based authentication support
+
+### Planned Features
+- 🔌 **Plugin Architecture**: Support for additional Sources of Truth and multiplexers
+- 🏢 **Multiple Sources of Truth**:
+  - HashiCorp Consul integration
+  - HashiCorp Bastion support
+  - AWS EC2 instance discovery
+  - Ansible inventory integration
+  - Static YAML/JSON host files
+- 🖥️ **Multiple Terminal Multiplexers**:
+  - Terminator support
+  - Hyper terminal integration
+  - iTerm2 native support (macOS)
+  - Custom multiplexer plugins
+- 📈 **Performance Optimization**: Enhanced performance for large host lists
+
+## � Installation
+
+### From PyPI (Recommended)
+
+```bash
+pip install sshplex
+```
+
+### From Source
+
+```bash
+git clone https://github.com/yourusername/sshplex.git
+cd sshplex
+pip install -e .
+```
+
+### Development Setup
+
+```bash
+git clone https://github.com/yourusername/sshplex.git
+cd sshplex
+./scripts/setup-dev.sh
+```
+
+## �📋 Prerequisites
+
+- **Python 3.8+**
+- **tmux** (for terminal multiplexing)
+- **NetBox** instance with API access
+- **SSH key** configured for target hosts
+- **macOS or Linux** (Windows support via WSL)
+
+### System Dependencies
+
+```bash
+# macOS (using Homebrew)
+brew install tmux python3
+
+# Ubuntu/Debian
+sudo apt update && sudo apt install tmux python3 python3-pip
+
+# RHEL/CentOS/Fedora
+sudo dnf install tmux python3 python3-pip
+```
+
+## 📸 Screenshots
+
+### TUI Host Selection Interface
+
+![host_lists.png](https://raw.githubusercontent.com/sabrimjd/sshplex/master/.github/images/host_lists.png)
+
+### TUI Session manager
+
+![session_manager.png](https://raw.githubusercontent.com/sabrimjd/sshplex/master/.github/images/session_manager.png)
+
+### TMUX Session with Multiple SSH Connections
+
+![tmux.png](https://raw.githubusercontent.com/sabrimjd/sshplex/master/.github/images/tmux.png)
+
+
+## 🚀 Quick Start
+
+### Option 1: Full TUI Interface (Recommended)
+```bash
+# Clone repository for full functionality
+git clone https://github.com/sabrimjd/sshplex.git
+cd sshplex
+
+# Install dependencies
+pip3 install -r requirements.txt
+
+# Run main TUI application
+python3 sshplex.py
+```
+
+### Option 2: CLI Debug Interface (Pip Install)
+```bash
+# Install from PyPI (once published)
+pip install sshplex
+
+# Use CLI debug interface
+sshplex-cli              # NetBox connectivity test
+sshplex-cli --help       # Show help
+```
+
+## 🚀 Installation
+
+### From PyPI (CLI Debug Interface)
+
+```bash
+pip install sshplex
+```
+
+This installs the `sshplex-cli` command for NetBox connectivity testing and configuration validation.
+
+### From Source (Full TUI Application)
+
+```bash
+git clone https://github.com/sabrimjd/sshplex.git
+cd sshplex
+pip install -r requirements.txt
+```
+
+This gives you access to the full TUI interface with tmux integration.
+
+## 📖 Usage
+
+### Basic Workflow
+
+1. **Start SSHplex**: Run `python3 sshplex.py`
+2. **Select Hosts**: Use the TUI to browse and select hosts from NetBox
+3. **Configure Session**: Choose between panes or windows, enable/disable broadcasting
+4. **Connect**: SSHplex creates a tmux session and establishes SSH connections
+5. **Work**: Use tmux commands to navigate between hosts
+6. **Detach/Reattach**: Use `Ctrl+b d` to detach, `tmux attach` to reattach
+
+### tmux Commands (once attached)
+
+```bash
+# Navigation
+Ctrl+b + Arrow Keys    # Switch between panes
+Ctrl+b + n/p          # Next/Previous window
+Ctrl+b + 0-9          # Switch to window by number
+
+# Session management
+Ctrl+b + d            # Detach from session
+tmux list-sessions    # List all tmux sessions
+tmux attach -t <name> # Attach to specific session
+
+# Pane management
+Ctrl+b + x            # Close current pane
+Ctrl+b + z            # Zoom/unzoom current pane
+```
+
+## ⚙️ Configuration Options
+
+### NetBox Filters
+
+Customize which hosts are retrieved from NetBox:
+
+```yaml
+netbox:
+  default_filters:
+    status: "active"           # Only active hosts
+    role: "virtual-machine"    # Only VMs
+    platform: "linux"         # Only Linux hosts
+    cluster: "production"      # Specific cluster
+    has_primary_ip: "true"     # Only hosts with IP addresses
+```
+
+### tmux Layouts
+
+Choose how SSH connections are arranged:
+
+- `tiled`: Automatic tiling layout (default)
+- `even-horizontal`: Horizontal split
+- `even-vertical`: Vertical split
+
+### Logging Control
+
+```yaml
+logging:
+  enabled: false  # Disable logging completely
+  level: "ERROR"  # Only show errors
+  file: "logs/sshplex.log"
+```
+
+## 🐛 Troubleshooting
+
+### Common Issues
+
+1. **NetBox Connection Failed**
+   - Verify URL and API token
+   - Check network connectivity
+   - Ensure SSL settings match your NetBox instance
+
+2. **SSH Key Authentication Failed**
+   - Verify SSH key path in configuration
+   - Ensure key has proper permissions (`chmod 600`)
+   - Test manual SSH connection to target hosts
+
+3. **tmux Session Not Created**
+   - Ensure tmux is installed and in PATH
+   - Check SSH connectivity to at least one host
+   - Verify tmux is not already running a session with the same name
+
+### Debug Mode
+
+Enable detailed logging for troubleshooting:
+
+```yaml
+logging:
+  enabled: true
+  level: "DEBUG"
+  file: "logs/sshplex.log"
+```
+
+## 🤝 Contributing
+
+SSHplex is in early development and welcomes contributions! Please note that the codebase follows the KISS (Keep It Simple, Stupid) principle.
+
+### Development Setup
+
+```bash
+# Clone and setup development environment
+git clone https://github.com/sabrimjd/sshplex.git
+cd sshplex/sshplex
+pip3 install -r requirements-dev.txt
+
+# Run tests
+python3 -m pytest tests/
+
+# Run with development configuration
+python3 sshplex.py --config config-template.yaml
+```
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 👤 Author
+
+**Sabrimjd**
+- GitHub: [@sabrimjd](https://github.com/sabrimjd)
+- Project: [sshplex](https://github.com/sabrimjd/sshplex)
+
+## 🙏 Acknowledgments
+
+- Built with [Textual](https://textual.textualize.io/) for the modern TUI experience
+- [NetBox](https://netbox.dev/) integration for infrastructure as code
+- [tmux](https://github.com/tmux/tmux) for reliable terminal multiplexing
+- [loguru](https://github.com/Delgan/loguru) for simple and powerful logging
+
+---
+
+**SSHplex** - Because managing multiple SSH connections should be simple and elegant.