ghps 0.6__tar.gz → 0.7__tar.gz

{ghps-0.6 → ghps-0.7}/CHANGELOG.md

@@ -5,6 +5,13 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+## [0.7] - 2026-09-22
+### Added
+- `host` parameter
+- `--host` CLI argument
+### Changed
+- Test system modified
+- `README.md` updated
 ## [0.6] - 2026-08-31
 ### Added
 - Custom default error page
@@ -52,7 +59,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Command line interface
 - Test system
 
-[Unreleased]: https://github.com/sepandhaghighi/ghps/compare/v0.6...dev
+[Unreleased]: https://github.com/sepandhaghighi/ghps/compare/v0.7...dev
+[0.7]: https://github.com/sepandhaghighi/ghps/compare/v0.6...v0.7
 [0.6]: https://github.com/sepandhaghighi/ghps/compare/v0.5...v0.6
 [0.5]: https://github.com/sepandhaghighi/ghps/compare/v0.4...v0.5
 [0.4]: https://github.com/sepandhaghighi/ghps/compare/v0.3...v0.4

{ghps-0.6 → ghps-0.7}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: ghps
-Version: 0.6
+Version: 0.7
 Summary: Ghps: A Minimal GitHub Pages Simulator for Local Development
 Home-page: https://github.com/sepandhaghighi/ghps
-Download-URL: https://github.com/sepandhaghighi/ghps/tarball/v0.6
+Download-URL: https://github.com/sepandhaghighi/ghps/tarball/v0.7
 Author: Sepand Haghighi
 Author-email: me@sepand.tech
 License: MIT
@@ -101,13 +101,13 @@ Dynamic: summary
 ## Installation		
 
 ### Source Code
-- Download [Version 0.6](https://github.com/sepandhaghighi/ghps/archive/v0.6.zip) or [Latest Source](https://github.com/sepandhaghighi/ghps/archive/dev.zip)
+- Download [Version 0.7](https://github.com/sepandhaghighi/ghps/archive/v0.7.zip) or [Latest Source](https://github.com/sepandhaghighi/ghps/archive/dev.zip)
 - `pip install .`				
 
 ### PyPI
 
 - Check [Python Packaging User Guide](https://packaging.python.org/installing/)     
-- `pip install ghps==0.6`						
+- `pip install ghps==0.7`						
 
 
 ## Usage
@@ -117,13 +117,14 @@ Ghps can be used both as a CLI tool and as a Python library.
 ### CLI
 
 ```bash
-ghps --port=8080 --no-cache --no-threaded
+ghps --host=127.0.0.1 --port=8080 --no-cache --no-threaded
 ```
 
 #### Options
 
 | Option | Description | Default |
 |--------|-------------|----------|
+| `--host` | Host address to bind to | `localhost` |
 | `-p, --port` | Port to serve on | `8000` |
 | `-d, --directory` | Directory to serve | Current directory (`.`) |
 | `-b, --base-path` | Base path for project pages (e.g. `/repo-name`) | `""` |
@@ -133,7 +134,11 @@ ghps --port=8080 --no-cache --no-threaded
 | `--auto-open` | Automatically open the server URL | Disable |
 | `--directory-listing` | Enable directory listing | Disable |
 
-ℹ️ You can set `--port=0` to let the OS automatically select an available port
+> [!NOTE]
+> You can set `--port=0` to let the OS automatically select an available port.
+
+> [!NOTE]
+> You can use `--host=0.0.0.0` to bind Ghps to all available network interfaces, or specify a particular address such as `127.0.0.1`.
 
 
 ### Library
@@ -143,6 +148,7 @@ from ghps import GHPageServer
 
 server = GHPageServer(
     directory="dist",
+	host="localhost",
     port=5000,
     base_path="/repo-name",
     strict=True,
@@ -159,6 +165,7 @@ server.start()
 | Parameter | Type | Description | Default |
 |------------|------|-------------|----------|
 | `directory` | `str` | Directory to serve | `"."` |
+| `host` | `str` | Host address to bind the server to | `"localhost"` |
 | `port` | `int` | Port number | `8000` |
 | `base_path` | `str` | Base path for project page simulation | `""` |
 | `strict` | `bool` | Enforce GitHub-like routing behavior | `True` |
@@ -167,7 +174,11 @@ server.start()
 | `auto_open` | `bool` | Automatically open the server URL | `False` |
 | `directory_listing` | `bool` | Enable directory listing | `False` |
 
-ℹ️ You can set `port=0` to let the OS automatically select an available port
+> [!NOTE]
+> You can set `port=0` to let the OS automatically select an available port.
+
+> [!NOTE]
+> The `host` parameter controls the network interface used for server binding. The default is `"localhost"`.
 
 ## Issues & Bug Reports			
 
@@ -218,6 +229,13 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+## [0.7] - 2026-09-22
+### Added
+- `host` parameter
+- `--host` CLI argument
+### Changed
+- Test system modified
+- `README.md` updated
 ## [0.6] - 2026-08-31
 ### Added
 - Custom default error page
@@ -265,7 +283,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Command line interface
 - Test system
 
-[Unreleased]: https://github.com/sepandhaghighi/ghps/compare/v0.6...dev
+[Unreleased]: https://github.com/sepandhaghighi/ghps/compare/v0.7...dev
+[0.7]: https://github.com/sepandhaghighi/ghps/compare/v0.6...v0.7
 [0.6]: https://github.com/sepandhaghighi/ghps/compare/v0.5...v0.6
 [0.5]: https://github.com/sepandhaghighi/ghps/compare/v0.4...v0.5
 [0.4]: https://github.com/sepandhaghighi/ghps/compare/v0.3...v0.4

{ghps-0.6 → ghps-0.7}/README.md

@@ -50,13 +50,13 @@
 ## Installation		
 
 ### Source Code
-- Download [Version 0.6](https://github.com/sepandhaghighi/ghps/archive/v0.6.zip) or [Latest Source](https://github.com/sepandhaghighi/ghps/archive/dev.zip)
+- Download [Version 0.7](https://github.com/sepandhaghighi/ghps/archive/v0.7.zip) or [Latest Source](https://github.com/sepandhaghighi/ghps/archive/dev.zip)
 - `pip install .`				
 
 ### PyPI
 
 - Check [Python Packaging User Guide](https://packaging.python.org/installing/)     
-- `pip install ghps==0.6`						
+- `pip install ghps==0.7`						
 
 
 ## Usage
@@ -66,13 +66,14 @@ Ghps can be used both as a CLI tool and as a Python library.
 ### CLI
 
 ```bash
-ghps --port=8080 --no-cache --no-threaded
+ghps --host=127.0.0.1 --port=8080 --no-cache --no-threaded
 ```
 
 #### Options
 
 | Option | Description | Default |
 |--------|-------------|----------|
+| `--host` | Host address to bind to | `localhost` |
 | `-p, --port` | Port to serve on | `8000` |
 | `-d, --directory` | Directory to serve | Current directory (`.`) |
 | `-b, --base-path` | Base path for project pages (e.g. `/repo-name`) | `""` |
@@ -82,7 +83,11 @@ ghps --port=8080 --no-cache --no-threaded
 | `--auto-open` | Automatically open the server URL | Disable |
 | `--directory-listing` | Enable directory listing | Disable |
 
-ℹ️ You can set `--port=0` to let the OS automatically select an available port
+> [!NOTE]
+> You can set `--port=0` to let the OS automatically select an available port.
+
+> [!NOTE]
+> You can use `--host=0.0.0.0` to bind Ghps to all available network interfaces, or specify a particular address such as `127.0.0.1`.
 
 
 ### Library
@@ -92,6 +97,7 @@ from ghps import GHPageServer
 
 server = GHPageServer(
     directory="dist",
+	host="localhost",
     port=5000,
     base_path="/repo-name",
     strict=True,
@@ -108,6 +114,7 @@ server.start()
 | Parameter | Type | Description | Default |
 |------------|------|-------------|----------|
 | `directory` | `str` | Directory to serve | `"."` |
+| `host` | `str` | Host address to bind the server to | `"localhost"` |
 | `port` | `int` | Port number | `8000` |
 | `base_path` | `str` | Base path for project page simulation | `""` |
 | `strict` | `bool` | Enforce GitHub-like routing behavior | `True` |
@@ -116,7 +123,11 @@ server.start()
 | `auto_open` | `bool` | Automatically open the server URL | `False` |
 | `directory_listing` | `bool` | Enable directory listing | `False` |
 
-ℹ️ You can set `port=0` to let the OS automatically select an available port
+> [!NOTE]
+> You can set `port=0` to let the OS automatically select an available port.
+
+> [!NOTE]
+> The `host` parameter controls the network interface used for server binding. The default is `"localhost"`.
 
 ## Issues & Bug Reports			
 

{ghps-0.6 → ghps-0.7}/SECURITY.md

@@ -4,8 +4,8 @@
 
 | Version       | Supported          |
 | ------------- | ------------------ |
-| 0.6           | :white_check_mark: |
-| < 0.6         | :x:                |
+| 0.7           | :white_check_mark: |
+| < 0.7         | :x:                |
 
 ## Reporting a Vulnerability
 

{ghps-0.6 → ghps-0.7}/ghps/cli.py

@@ -32,6 +32,13 @@ def _parse_args() -> argparse.Namespace:
         help="Version"
     )
 
+    parser.add_argument(
+        "--host",
+        type=str,
+        default="localhost",
+        help="Host address to bind to (default: localhost)"
+    )
+
     parser.add_argument(
         "-p", "--port",
         type=int,
@@ -94,6 +101,7 @@ def main() -> None:
         else:
             server = GHPageServer(
                 directory=args.directory,
+                host=args.host,
                 port=args.port,
                 base_path=args.base_path,
                 strict=not args.no_strict,

{ghps-0.6 → ghps-0.7}/ghps/params.py

@@ -1,13 +1,14 @@
 # -*- coding: utf-8 -*-
 """ghps params."""
 
-GHPS_VERSION = "0.6"
+GHPS_VERSION = "0.7"
 GHPS_REPO = "https://github.com/sepandhaghighi/ghps"
 
 INVALID_DIRECTORY_TYPE_ERROR = "`directory` must be str or pathlib.Path."
 DIRECTORY_NOT_FOUND_ERROR = "`directory` does not exist."
 DIRECTORY_NOT_DIR_ERROR = "`directory` must be a valid directory."
 
+INVALID_HOST_TYPE_ERROR = "`host` must be str."
 INVALID_PORT_TYPE_ERROR = "`port` must be int."
 INVALID_PORT_RANGE_ERROR = "`port` must be between 0 and 65535."
 

{ghps-0.6 → ghps-0.7}/ghps/server.py

@@ -17,6 +17,7 @@ from .params import (
     INVALID_DIRECTORY_TYPE_ERROR,
     DIRECTORY_NOT_FOUND_ERROR,
     DIRECTORY_NOT_DIR_ERROR,
+    INVALID_HOST_TYPE_ERROR,
     INVALID_PORT_TYPE_ERROR,
     INVALID_PORT_RANGE_ERROR,
     INVALID_BASE_PATH_TYPE_ERROR,
@@ -38,6 +39,7 @@ from .errors import GHPSValidationError, GHPSRuntimeError
 
 def _validate_inputs(
     directory: Any,
+    host: Any,
     port: Any,
     base_path: Any,
     strict: Any,
@@ -50,6 +52,7 @@ def _validate_inputs(
     Validate GHPageServer inputs.
 
     :param directory: Root directory to serve files from.
+    :param host: Host address to bind the server to.
     :param port: Port number to bind the server to.
     :param base_path: URL base path prefix for serving content.
     :param strict: If False, enables automatic ".html" resolution.
@@ -68,6 +71,9 @@ def _validate_inputs(
     if not directory.is_dir():
         raise GHPSValidationError(DIRECTORY_NOT_DIR_ERROR)
 
+    if not isinstance(host, str):
+        raise GHPSValidationError(INVALID_HOST_TYPE_ERROR)
+
     if not isinstance(port, int) or isinstance(port, bool):
         raise GHPSValidationError(INVALID_PORT_TYPE_ERROR)
 
@@ -249,6 +255,7 @@ class GHPageServer:
     def __init__(
         self,
         directory: str = ".",
+        host: str = "localhost",
         port: int = 8000,
         base_path: str = "",
         strict: bool = True,
@@ -261,6 +268,7 @@ class GHPageServer:
         Initialize the server.
 
         :param directory: Root directory to serve files from.
+        :param host: Host address to bind the server to.
         :param port: Port number to bind the server to.
         :param base_path: URL base path prefix for serving content.
         :param strict: If False, enables automatic ".html" resolution.
@@ -271,6 +279,7 @@ class GHPageServer:
         """
         _validate_inputs(
             directory=directory,
+            host=host,
             port=port,
             base_path=base_path,
             strict=strict,
@@ -280,6 +289,7 @@ class GHPageServer:
             directory_listing=directory_listing
         )
         self._directory = str(Path(directory).resolve())
+        self._host = host
         self._port = port
         self._url = None
         self._base_path = base_path
@@ -315,11 +325,11 @@ class GHPageServer:
         server_cls = _ThreadedTCPServer if self._threaded else socketserver.TCPServer
 
         try:
-            self._httpd = server_cls(("", self._port), handler)
+            self._httpd = server_cls((self._host, self._port), handler)
         except OSError as e:
             _handle_bind_error(self._port, e)
         self._port = self._httpd.server_address[1]
-        self._url = f"http://localhost:{self._port}{self._base_path}"
+        self._url = f"http://{self._host}:{self._port}{self._base_path}"
         self._print_server_info()
 
         if self._auto_open:

{ghps-0.6 → ghps-0.7}/ghps.egg-info/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: ghps
-Version: 0.6
+Version: 0.7
 Summary: Ghps: A Minimal GitHub Pages Simulator for Local Development
 Home-page: https://github.com/sepandhaghighi/ghps
-Download-URL: https://github.com/sepandhaghighi/ghps/tarball/v0.6
+Download-URL: https://github.com/sepandhaghighi/ghps/tarball/v0.7
 Author: Sepand Haghighi
 Author-email: me@sepand.tech
 License: MIT
@@ -101,13 +101,13 @@ Dynamic: summary
 ## Installation		
 
 ### Source Code
-- Download [Version 0.6](https://github.com/sepandhaghighi/ghps/archive/v0.6.zip) or [Latest Source](https://github.com/sepandhaghighi/ghps/archive/dev.zip)
+- Download [Version 0.7](https://github.com/sepandhaghighi/ghps/archive/v0.7.zip) or [Latest Source](https://github.com/sepandhaghighi/ghps/archive/dev.zip)
 - `pip install .`				
 
 ### PyPI
 
 - Check [Python Packaging User Guide](https://packaging.python.org/installing/)     
-- `pip install ghps==0.6`						
+- `pip install ghps==0.7`						
 
 
 ## Usage
@@ -117,13 +117,14 @@ Ghps can be used both as a CLI tool and as a Python library.
 ### CLI
 
 ```bash
-ghps --port=8080 --no-cache --no-threaded
+ghps --host=127.0.0.1 --port=8080 --no-cache --no-threaded
 ```
 
 #### Options
 
 | Option | Description | Default |
 |--------|-------------|----------|
+| `--host` | Host address to bind to | `localhost` |
 | `-p, --port` | Port to serve on | `8000` |
 | `-d, --directory` | Directory to serve | Current directory (`.`) |
 | `-b, --base-path` | Base path for project pages (e.g. `/repo-name`) | `""` |
@@ -133,7 +134,11 @@ ghps --port=8080 --no-cache --no-threaded
 | `--auto-open` | Automatically open the server URL | Disable |
 | `--directory-listing` | Enable directory listing | Disable |
 
-ℹ️ You can set `--port=0` to let the OS automatically select an available port
+> [!NOTE]
+> You can set `--port=0` to let the OS automatically select an available port.
+
+> [!NOTE]
+> You can use `--host=0.0.0.0` to bind Ghps to all available network interfaces, or specify a particular address such as `127.0.0.1`.
 
 
 ### Library
@@ -143,6 +148,7 @@ from ghps import GHPageServer
 
 server = GHPageServer(
     directory="dist",
+	host="localhost",
     port=5000,
     base_path="/repo-name",
     strict=True,
@@ -159,6 +165,7 @@ server.start()
 | Parameter | Type | Description | Default |
 |------------|------|-------------|----------|
 | `directory` | `str` | Directory to serve | `"."` |
+| `host` | `str` | Host address to bind the server to | `"localhost"` |
 | `port` | `int` | Port number | `8000` |
 | `base_path` | `str` | Base path for project page simulation | `""` |
 | `strict` | `bool` | Enforce GitHub-like routing behavior | `True` |
@@ -167,7 +174,11 @@ server.start()
 | `auto_open` | `bool` | Automatically open the server URL | `False` |
 | `directory_listing` | `bool` | Enable directory listing | `False` |
 
-ℹ️ You can set `port=0` to let the OS automatically select an available port
+> [!NOTE]
+> You can set `port=0` to let the OS automatically select an available port.
+
+> [!NOTE]
+> The `host` parameter controls the network interface used for server binding. The default is `"localhost"`.
 
 ## Issues & Bug Reports			
 
@@ -218,6 +229,13 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+## [0.7] - 2026-09-22
+### Added
+- `host` parameter
+- `--host` CLI argument
+### Changed
+- Test system modified
+- `README.md` updated
 ## [0.6] - 2026-08-31
 ### Added
 - Custom default error page
@@ -265,7 +283,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Command line interface
 - Test system
 
-[Unreleased]: https://github.com/sepandhaghighi/ghps/compare/v0.6...dev
+[Unreleased]: https://github.com/sepandhaghighi/ghps/compare/v0.7...dev
+[0.7]: https://github.com/sepandhaghighi/ghps/compare/v0.6...v0.7
 [0.6]: https://github.com/sepandhaghighi/ghps/compare/v0.5...v0.6
 [0.5]: https://github.com/sepandhaghighi/ghps/compare/v0.4...v0.5
 [0.4]: https://github.com/sepandhaghighi/ghps/compare/v0.3...v0.4

{ghps-0.6 → ghps-0.7}/setup.py

@@ -22,7 +22,7 @@ def read_description() -> str:
 setup(
     name='ghps',
     packages=['ghps'],
-    version='0.6',
+    version='0.7',
     description='Ghps: A Minimal GitHub Pages Simulator for Local Development',
     long_description=read_description(),
     long_description_content_type='text/markdown',
@@ -30,7 +30,7 @@ setup(
     author='Sepand Haghighi',
     author_email='me@sepand.tech',
     url='https://github.com/sepandhaghighi/ghps',
-    download_url='https://github.com/sepandhaghighi/ghps/tarball/v0.6',
+    download_url='https://github.com/sepandhaghighi/ghps/tarball/v0.7',
     keywords='github gh-pages static-server static-hosting development server local http simulator testing cli python',
     project_urls={
         'Source': 'https://github.com/sepandhaghighi/ghps'

{ghps-0.6 → ghps-0.7}/tests/test_cli.py

@@ -36,6 +36,7 @@ def test_cli_default_arguments(monkeypatch):
 
     run_cli(monkeypatch, [])
 
+    assert captured["host"] == "localhost"
     assert captured["port"] == 8000
     assert captured["strict"] is True
     assert captured["no_cache"] is False
@@ -64,6 +65,26 @@ def test_cli_custom_port_and_directory(monkeypatch, tmp_path):
     assert captured["directory"] == str(tmp_path.resolve())
 
 
+def test_cli_host(monkeypatch):
+    captured = {}
+
+    def fake_init(self, **kwargs):
+        captured.update(kwargs)
+
+    monkeypatch.setattr(ghps.cli, "GHPageServer", type(
+        "MockServer",
+        (),
+        {
+            "__init__": fake_init,
+            "start": lambda self: None,
+        },
+    ))
+
+    run_cli(monkeypatch, ["--host", "127.0.0.1"])
+
+    assert captured["host"] == "127.0.0.1"
+
+
 def test_cli_base_path(monkeypatch):
     captured = {}
 

{ghps-0.6 → ghps-0.7}/tests/test_error.py

@@ -47,6 +47,20 @@ def test_directory_not_directory(tmp_path):
         )
 
 
+def test_invalid_host_type(tmp_path):
+    with pytest.raises(GHPSValidationError, match="`host` must be str."):
+        GHPageServer(
+            directory=tmp_path,
+            port=8000,
+            host=123,
+            base_path="",
+            strict=True,
+            no_cache=False,
+            threaded=True,
+            directory_listing=False,
+        )
+
+
 def test_invalid_port_type1(tmp_path):
     with pytest.raises(GHPSValidationError, match="`port` must be int."):
         GHPageServer(

{ghps-0.6 → ghps-0.7}/tests/test_server.py

@@ -259,6 +259,25 @@ def test_auto_open_disabled(mock_server_cls, mock_web_open, tmp_path):
     mock_web_open.assert_not_called()
 
 
+@patch("ghps.server.webbrowser.open")
+@patch("ghps.server._ThreadedTCPServer")
+def test_auto_open_custom_host(mock_server_cls, mock_web_open, tmp_path):
+    mock_server = mock_server_cls.return_value
+    mock_server.server_address = ("127.0.0.1", 8000)
+    mock_server.serve_forever.side_effect = KeyboardInterrupt
+
+    server = GHPageServer(
+        directory=tmp_path,
+        port=8000,
+        host="127.0.0.1",
+        auto_open=True,
+    )
+
+    server.start()
+
+    mock_web_open.assert_called_once_with("http://127.0.0.1:8000")
+
+
 @patch("ghps.server._ThreadedTCPServer")
 def test_random_port_resolution(mock_server_cls, tmp_path):
     mock_server = mock_server_cls.return_value
@@ -272,6 +291,26 @@ def test_random_port_resolution(mock_server_cls, tmp_path):
     assert server._port == 54321
 
 
+@patch("ghps.server._ThreadedTCPServer")
+def test_custom_host_binding(mock_server_cls, tmp_path):
+    mock_server = mock_server_cls.return_value
+    mock_server.server_address = ("127.0.0.1", 8000)
+    mock_server.serve_forever.side_effect = KeyboardInterrupt
+
+    server = GHPageServer(
+        directory=tmp_path,
+        port=8000,
+        host="127.0.0.1",
+    )
+
+    server.start()
+
+    mock_server_cls.assert_called_once()
+    address = mock_server_cls.call_args[0][0]
+
+    assert address == ("127.0.0.1", 8000)
+
+
 def test_directory_listing_enabled():
     with tempfile.TemporaryDirectory() as tmpdir:
         Path(tmpdir, "file.txt").write_text("Hello")