ssh-docs 0.1.0__tar.gz → 0.1.1__tar.gz

{ssh_docs-0.1.0 → ssh_docs-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ssh-docs
-Version: 0.1.0
+Version: 0.1.1
 Summary: Expose documentation via SSH - browse docs using familiar Unix commands
 Author: SSH-Docs Contributors
 License: MIT
@@ -33,8 +33,14 @@ Requires-Dist: mypy>=1.0.0; extra == "dev"
 
 # SSH-Docs
 
+[![PyPI version](https://badge.fury.io/py/ssh-docs.svg)](https://badge.fury.io/py/ssh-docs)
+[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
 **Expose documentation via SSH** - Browse your documentation using familiar Unix commands over SSH.
 
+**🎉 Now available on PyPI!** Install with: `pip install ssh-docs`
+
 ## Features
 
 - 🔒 **Secure SSH Access** - Standard SSH protocol with authentication options
@@ -282,6 +288,63 @@ ssh-docs keygen
 ssh-docs keygen --output-dir ./keys
 ```
 
+## Shell Completion
+
+SSH-Docs supports tab completion for commands, options, and file paths in Bash, Zsh, and Fish shells.
+
+### Installation
+
+**Bash:**
+```bash
+# Add to ~/.bashrc
+ssh-docs completion --shell bash >> ~/.bashrc
+source ~/.bashrc
+```
+
+**Zsh:**
+```zsh
+# Add to ~/.zshrc
+ssh-docs completion --shell zsh >> ~/.zshrc
+source ~/.zshrc
+```
+
+**Fish:**
+```fish
+# Add to ~/.config/fish/config.fish
+ssh-docs completion --shell fish >> ~/.config/fish/config.fish
+source ~/.config/fish/config.fish
+```
+
+### What Gets Completed
+
+Once enabled, tab completion works for:
+
+- **Commands**: `serve`, `init`, `validate`, `keygen`, `completion`
+- **Options**: `--port`, `--config`, `--auth`, etc.
+- **Values**: Authentication types (`public`, `key`, `password`)
+- **File Paths**: Config files, directories, and other paths
+- **Config Files**: Automatically suggests `.yml` and `.yaml` files
+
+### Usage Examples
+
+```bash
+# Press TAB to complete commands
+ssh-docs <TAB>
+# Shows: serve  init  validate  keygen  completion
+
+# Press TAB to complete options
+ssh-docs serve --<TAB>
+# Shows: --port  --config  --auth  --host  ...
+
+# Press TAB to complete auth types
+ssh-docs serve --auth <TAB>
+# Shows: public  key  password
+
+# Press TAB to complete config files
+ssh-docs serve --config <TAB>
+# Shows: .ssh-docs.yml  custom-config.yml  ...
+```
+
 ## Use Cases
 
 ### Local Development

{ssh_docs-0.1.0 → ssh_docs-0.1.1}/README.md

@@ -1,7 +1,13 @@
 # SSH-Docs
 
+[![PyPI version](https://badge.fury.io/py/ssh-docs.svg)](https://badge.fury.io/py/ssh-docs)
+[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
 **Expose documentation via SSH** - Browse your documentation using familiar Unix commands over SSH.
 
+**🎉 Now available on PyPI!** Install with: `pip install ssh-docs`
+
 ## Features
 
 - 🔒 **Secure SSH Access** - Standard SSH protocol with authentication options
@@ -249,6 +255,63 @@ ssh-docs keygen
 ssh-docs keygen --output-dir ./keys
 ```
 
+## Shell Completion
+
+SSH-Docs supports tab completion for commands, options, and file paths in Bash, Zsh, and Fish shells.
+
+### Installation
+
+**Bash:**
+```bash
+# Add to ~/.bashrc
+ssh-docs completion --shell bash >> ~/.bashrc
+source ~/.bashrc
+```
+
+**Zsh:**
+```zsh
+# Add to ~/.zshrc
+ssh-docs completion --shell zsh >> ~/.zshrc
+source ~/.zshrc
+```
+
+**Fish:**
+```fish
+# Add to ~/.config/fish/config.fish
+ssh-docs completion --shell fish >> ~/.config/fish/config.fish
+source ~/.config/fish/config.fish
+```
+
+### What Gets Completed
+
+Once enabled, tab completion works for:
+
+- **Commands**: `serve`, `init`, `validate`, `keygen`, `completion`
+- **Options**: `--port`, `--config`, `--auth`, etc.
+- **Values**: Authentication types (`public`, `key`, `password`)
+- **File Paths**: Config files, directories, and other paths
+- **Config Files**: Automatically suggests `.yml` and `.yaml` files
+
+### Usage Examples
+
+```bash
+# Press TAB to complete commands
+ssh-docs <TAB>
+# Shows: serve  init  validate  keygen  completion
+
+# Press TAB to complete options
+ssh-docs serve --<TAB>
+# Shows: --port  --config  --auth  --host  ...
+
+# Press TAB to complete auth types
+ssh-docs serve --auth <TAB>
+# Shows: public  key  password
+
+# Press TAB to complete config files
+ssh-docs serve --config <TAB>
+# Shows: .ssh-docs.yml  custom-config.yml  ...
+```
+
 ## Use Cases
 
 ### Local Development

{ssh_docs-0.1.0 → ssh_docs-0.1.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ssh-docs"
-version = "0.1.0"
+version = "0.1.1"
 description = "Expose documentation via SSH - browse docs using familiar Unix commands"
 readme = "README.md"
 requires-python = ">=3.8"

{ssh_docs-0.1.0 → ssh_docs-0.1.1}/ssh_docs/cli.py

@@ -8,6 +8,7 @@ from pathlib import Path
 from typing import Optional
 
 import click
+from click.shell_completion import CompletionItem
 
 from .config import (
     Config,
@@ -19,6 +20,19 @@ from .config import (
 from .server import run_server
 
 
+
+
+def complete_config_files(ctx, param, incomplete):
+    """Complete .yml and .yaml config files in current directory."""
+    from pathlib import Path
+    configs = list(Path(".").glob("*.yml")) + list(Path(".").glob("*.yaml"))
+    return [
+        CompletionItem(str(c))
+        for c in configs
+        if str(c).startswith(incomplete)
+    ]
+
+
 @click.group()
 @click.version_option(version="0.1.0", prog_name="ssh-docs")
 def cli() -> None:
@@ -50,6 +64,7 @@ def cli() -> None:
     "--config",
     type=click.Path(exists=True),
     default=None,
+    shell_complete=complete_config_files,
     help="Config file path [default: .ssh-docs.yml]",
 )
 @click.option(
@@ -383,6 +398,53 @@ def keygen(output_dir: Optional[str], force: bool) -> None:
     click.echo(f"  host_key: {key_path}")
 
 
+
+
+@cli.command()
+@click.option(
+    "--shell",
+    type=click.Choice(["bash", "zsh", "fish"]),
+    required=True,
+    help="Shell type",
+)
+def completion(shell: str) -> None:
+    """Generate shell completion script.
+    
+    Install tab completion for your shell to autocomplete commands,
+    options, and file paths.
+    
+    Examples:
+    
+      \b
+      # Install for bash
+      ssh-docs completion --shell bash >> ~/.bashrc
+      source ~/.bashrc
+      
+      \b
+      # Install for zsh
+      ssh-docs completion --shell zsh >> ~/.zshrc
+      source ~/.zshrc
+      
+      \b
+      # Install for fish
+      ssh-docs completion --shell fish >> ~/.config/fish/config.fish
+      source ~/.config/fish/config.fish
+    """
+    shell_map = {
+        "bash": "bash_source",
+        "zsh": "zsh_source",
+        "fish": "fish_source",
+    }
+    
+    prog_name = "ssh-docs"
+    complete_var = f"_{prog_name.upper().replace('-', '_')}_COMPLETE"
+    
+    if shell == "fish":
+        click.echo(f"eval (env {complete_var}={shell_map[shell]} {prog_name})")
+    else:
+        click.echo(f'eval "$({complete_var}={shell_map[shell]} {prog_name})"')
+
+
 def main() -> None:
     """Main entry point for CLI."""
     cli()

{ssh_docs-0.1.0 → ssh_docs-0.1.1}/ssh_docs/server.py

@@ -38,9 +38,7 @@ class SSHDocsServer:
         # Configure server options
         server_options = {
             "server_host_keys": [host_key],
-            "process_factory": self._create_process,
-            "session_factory": None,  # We handle sessions via process_factory
-            "encoding": None,  # Handle encoding in shell
+            "encoding": "utf-8",  # Use UTF-8 encoding for text
         }
         
         # Add authentication if configured
@@ -51,9 +49,9 @@ class SSHDocsServer:
             server_options["authorized_client_keys"] = self.config.authorized_keys
         
         else:
-            # Public access - accept any connection
-            server_options["password_auth"] = False
-            server_options["public_key_auth"] = False
+            # Public access - accept any connection without authentication
+            # We enable password auth but accept any password
+            server_options["password_auth"] = True
         
         logger.info(f"Starting SSH server on {self.config.host}:{self.config.port}")
         logger.info(f"Content root: {self.content_root}")
@@ -81,9 +79,7 @@ class SSHDocsServer:
             await self.server.wait_closed()
             logger.info("SSH server stopped")
 
-    def _create_process(self) -> SSHDocsProcess:
-        """Factory method to create a new process for each connection."""
-        return SSHDocsProcess(self)
+
 
     async def _get_host_key(self) -> str:
         """Get or generate SSH host key."""
@@ -131,18 +127,34 @@ class SSHDocsServerProtocol(asyncssh.SSHServer):
         """Begin authentication for a user."""
         logger.debug(f"Authentication attempt for user: {username}")
         
-        # For public access, accept any username
+        # For public access, skip authentication entirely
         if self.server.config.auth_type == "public":
-            return True
+            # Returning False skips authentication
+            return False
         
         return True
 
     def password_auth_supported(self) -> bool:
         """Check if password authentication is supported."""
+        # Only support password auth for password mode, not public
         return self.server.config.auth_type == "password"
+    
+    def public_key_auth_supported(self) -> bool:
+        """Check if public key authentication is supported."""
+        # Support public key auth for key mode
+        return self.server.config.auth_type == "key"
+    
+    def kbdint_auth_supported(self) -> bool:
+        """Check if keyboard-interactive authentication is supported."""
+        # Not supported
+        return False
 
     def validate_password(self, username: str, password: str) -> bool:
         """Validate password for a user."""
+        # For public access, accept any password
+        if self.server.config.auth_type == "public":
+            return True
+            
         if self.server.config.auth_type != "password":
             return False
         
@@ -150,54 +162,35 @@ class SSHDocsServerProtocol(asyncssh.SSHServer):
             return False
         
         return password == self.server.config.password
+    
+    def session_requested(self):
+        """Handle session request by returning a handler function."""
+        async def handle_session(stdin, stdout, stderr):
+            """Handler function that receives stream objects."""
+            shell = SSHDocsShell(
+                stdin=stdin,
+                stdout=stdout,
+                stderr=stderr,
+                content_root=self.server.content_root,
+                site_name=self.server.config.site_name,
+                banner=self.server.config.banner,
+            )
+            try:
+                logger.info("Starting shell session")
+                await shell.run()
+                logger.info("Shell session ended normally")
+            except Exception as e:
+                logger.error(f"Shell error: {e}", exc_info=True)
+            finally:
+                # Close streams to signal session completion
+                stdout.close()
+                stderr.close()
+                logger.info("Streams closed")
+        
+        return handle_session
 
 
-class SSHDocsProcess(asyncssh.SSHServerProcess):
-    """Process handler for SSH sessions."""
-
-    def __init__(self, server: SSHDocsServer) -> None:
-        self.server = server
-        self.shell: Optional[SSHDocsShell] = None
-
-    def connection_made(self, chan: asyncssh.SSHServerChannel) -> None:
-        """Called when channel is opened."""
-        self.chan = chan
-
-    def shell_requested(self) -> bool:
-        """Handle shell request."""
-        return True
-
-    def session_started(self) -> None:
-        """Called when session starts."""
-        # Create shell instance
-        self.shell = SSHDocsShell(
-            stdin=self.stdin,
-            stdout=self.stdout,
-            stderr=self.stderr,
-            content_root=self.server.content_root,
-            site_name=self.server.config.site_name,
-            banner=self.server.config.banner,
-        )
-        
-        # Start shell in background task
-        asyncio.create_task(self._run_shell())
-
-    async def _run_shell(self) -> None:
-        """Run the shell session."""
-        try:
-            await self.shell.run()
-        except Exception as e:
-            logger.error(f"Shell error: {e}")
-        finally:
-            self.exit(0)
-
-    def break_received(self, msec: int) -> bool:
-        """Handle break signal."""
-        return True
 
-    def signal_received(self, signal: str) -> None:
-        """Handle signal."""
-        logger.debug(f"Received signal: {signal}")
 
 
 async def run_server(config: Config) -> None:

{ssh_docs-0.1.0 → ssh_docs-0.1.1}/ssh_docs/shell.py

@@ -8,6 +8,8 @@ import shlex
 from pathlib import Path
 from typing import Any, Callable, Optional
 
+import asyncssh
+
 
 class SSHDocsShell:
     """Interactive shell session that provides Unix-like commands for browsing documentation."""
@@ -28,6 +30,99 @@ class SSHDocsShell:
         self.site_name = site_name
         self.cwd = "/site"
         self.banner = banner or self._default_banner()
+        self.commands = ["help", "pwd", "ls", "cd", "cat", "head", "tail", "find", "grep", "exit", "quit"]
+
+    def _get_completions(self, text: str, state: int) -> Optional[str]:
+        """Generate completions for tab completion."""
+        # Parse the current line to understand context
+        line_before_cursor = text
+        parts = line_before_cursor.split()
+        
+        # If empty or just whitespace, suggest commands
+        if not parts or (len(parts) == 1 and not line_before_cursor.endswith(' ')):
+            prefix = parts[0] if parts else ""
+            matches = [cmd for cmd in self.commands if cmd.startswith(prefix)]
+            return matches[state] if state < len(matches) else None
+        
+        # If we have a command, complete paths/files
+        command = parts[0]
+        if command in self.commands:
+            # Get the last argument being typed
+            if line_before_cursor.endswith(' '):
+                prefix = ""
+            else:
+                prefix = parts[-1] if len(parts) > 1 else ""
+            
+            # Complete file/directory paths
+            matches = self._complete_path(prefix)
+            return matches[state] if state < len(matches) else None
+        
+        return None
+    
+    def _complete_path(self, prefix: str) -> list[str]:
+        """Complete file and directory paths."""
+        # Determine the directory to search and the prefix to match
+        if prefix.startswith('/'):
+            # Absolute path - extract directory and filename parts
+            if prefix.endswith('/'):
+                # Path ends with /, list contents of that directory
+                dir_part = prefix.rstrip('/')
+                file_part = ''
+            elif '/' in prefix.rstrip('/')[1:]:  # Has more than just /
+                dir_part = prefix.rsplit('/', 1)[0] or '/'
+                file_part = prefix.rsplit('/', 1)[1]
+            else:
+                dir_part = '/site'
+                file_part = prefix[1:] if len(prefix) > 1 else ''
+            virtual_path = dir_part
+        else:
+            # Relative path
+            if '/' in prefix:
+                dir_part = prefix.rsplit('/', 1)[0]
+                file_part = prefix.rsplit('/', 1)[1]
+                virtual_path = self._resolve_virtual_path(dir_part)
+            else:
+                # Just a filename in current directory
+                dir_part = ''
+                file_part = prefix
+                virtual_path = self.cwd
+        
+        real_path = self._to_real_path(virtual_path)
+        if not real_path or not real_path.exists() or not real_path.is_dir():
+            return []
+        
+        # Get matching entries
+        try:
+            entries = []
+            for child in sorted(real_path.iterdir(), key=lambda p: (not p.is_dir(), p.name.lower())):
+                name = child.name
+                
+                # Skip if doesn't match prefix
+                if not name.startswith(file_part):
+                    continue
+                
+                # Build the completion string
+                if prefix.startswith('/'):
+                    # Absolute path - return full virtual path
+                    full_name = self._to_virtual_path(child)
+                elif dir_part:
+                    # Relative path with directory component
+                    full_name = f"{dir_part}/{name}"
+                else:
+                    # Just filename
+                    full_name = name
+                
+                # Add trailing slash for directories
+                if child.is_dir():
+                    full_name += "/"
+                
+                entries.append(full_name)
+            
+            return entries
+        except (PermissionError, OSError):
+            return []
+
+
 
     def _default_banner(self) -> str:
         return f"""Connected to {self.site_name}.ssh-docs
@@ -39,17 +134,90 @@ Readonly session
 """
 
     async def run(self) -> None:
-        """Main command loop."""
+        """Main command loop with tab completion support."""
+        import logging
+        logger = logging.getLogger(__name__)
+        
+        logger.info("Shell run() started")
         self.stdout.write(self.banner)
+        logger.info("Banner written")
 
+        # Buffer for current line being edited
+        current_line = ""
+        
         while True:
             try:
-                self.stdout.write(f"{self.cwd}$ ")
-                line = await self.stdin.readline()
-                if not line:
-                    break
-
-                raw = line.strip()
+                prompt = f"{self.cwd}$ "
+                self.stdout.write(prompt)
+                
+                # Read input character by character to handle tab completion
+                current_line = ""
+                while True:
+                    char = await self.stdin.read(1)
+                    
+                    if not char:
+                        logger.info("Connection closed")
+                        return
+                    
+                    # Handle tab completion
+                    if char == '\t':
+                        completions = self._complete_path(current_line.split()[-1] if current_line.split() else "")
+                        
+                        if len(completions) == 1:
+                            # Single match - complete it
+                            parts = current_line.split()
+                            if parts:
+                                # Replace last part with completion
+                                parts[-1] = completions[0]
+                                current_line = ' '.join(parts)
+                            else:
+                                current_line = completions[0]
+                            
+                            # Clear line and rewrite
+                            self.stdout.write('\r' + ' ' * (len(prompt) + len(current_line) + 10) + '\r')
+                            self.stdout.write(prompt + current_line)
+                            
+                        elif len(completions) > 1:
+                            # Multiple matches - show them
+                            self.stdout.write('\n')
+                            for comp in completions:
+                                self.stdout.write(f"{comp}  ")
+                            self.stdout.write('\n')
+                            self.stdout.write(prompt + current_line)
+                        
+                        continue
+                    
+                    # Handle backspace
+                    elif char in ('\x7f', '\x08'):
+                        if current_line:
+                            current_line = current_line[:-1]
+                            self.stdout.write('\b \b')
+                        continue
+                    
+                    # Handle newline
+                    elif char in ('\n', '\r'):
+                        self.stdout.write('\n')
+                        break
+                    
+                    # Handle Ctrl+C
+                    elif char == '\x03':
+                        self.stdout.write('^C\n')
+                        current_line = ""
+                        break
+                    
+                    # Handle Ctrl+D
+                    elif char == '\x04':
+                        if not current_line:
+                            self.stdout.write('\nSession closed\n')
+                            return
+                        continue
+                    
+                    # Regular character
+                    else:
+                        current_line += char
+                        self.stdout.write(char)
+                
+                raw = current_line.strip()
                 if not raw:
                     continue
 

{ssh_docs-0.1.0 → ssh_docs-0.1.1}/ssh_docs.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ssh-docs
-Version: 0.1.0
+Version: 0.1.1
 Summary: Expose documentation via SSH - browse docs using familiar Unix commands
 Author: SSH-Docs Contributors
 License: MIT
@@ -33,8 +33,14 @@ Requires-Dist: mypy>=1.0.0; extra == "dev"
 
 # SSH-Docs
 
+[![PyPI version](https://badge.fury.io/py/ssh-docs.svg)](https://badge.fury.io/py/ssh-docs)
+[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
 **Expose documentation via SSH** - Browse your documentation using familiar Unix commands over SSH.
 
+**🎉 Now available on PyPI!** Install with: `pip install ssh-docs`
+
 ## Features
 
 - 🔒 **Secure SSH Access** - Standard SSH protocol with authentication options
@@ -282,6 +288,63 @@ ssh-docs keygen
 ssh-docs keygen --output-dir ./keys
 ```
 
+## Shell Completion
+
+SSH-Docs supports tab completion for commands, options, and file paths in Bash, Zsh, and Fish shells.
+
+### Installation
+
+**Bash:**
+```bash
+# Add to ~/.bashrc
+ssh-docs completion --shell bash >> ~/.bashrc
+source ~/.bashrc
+```
+
+**Zsh:**
+```zsh
+# Add to ~/.zshrc
+ssh-docs completion --shell zsh >> ~/.zshrc
+source ~/.zshrc
+```
+
+**Fish:**
+```fish
+# Add to ~/.config/fish/config.fish
+ssh-docs completion --shell fish >> ~/.config/fish/config.fish
+source ~/.config/fish/config.fish
+```
+
+### What Gets Completed
+
+Once enabled, tab completion works for:
+
+- **Commands**: `serve`, `init`, `validate`, `keygen`, `completion`
+- **Options**: `--port`, `--config`, `--auth`, etc.
+- **Values**: Authentication types (`public`, `key`, `password`)
+- **File Paths**: Config files, directories, and other paths
+- **Config Files**: Automatically suggests `.yml` and `.yaml` files
+
+### Usage Examples
+
+```bash
+# Press TAB to complete commands
+ssh-docs <TAB>
+# Shows: serve  init  validate  keygen  completion
+
+# Press TAB to complete options
+ssh-docs serve --<TAB>
+# Shows: --port  --config  --auth  --host  ...
+
+# Press TAB to complete auth types
+ssh-docs serve --auth <TAB>
+# Shows: public  key  password
+
+# Press TAB to complete config files
+ssh-docs serve --config <TAB>
+# Shows: .ssh-docs.yml  custom-config.yml  ...
+```
+
 ## Use Cases
 
 ### Local Development