ghps 0.6__tar.gz → 0.8__tar.gz

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

@@ -5,6 +5,24 @@ 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.8] - 2026-11-08
+### Added
+- `quiet` parameter
+- `--quiet` CLI argument
+- `--config` CLI argument
+- `from_config` method
+### Changed
+- Test system modified
+- Build system modified
+- `Python 3.15` added to `test.yml`
+- `README.md` updated
+## [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 +70,9 @@ 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.8...dev
+[0.8]: https://github.com/sepandhaghighi/ghps/compare/v0.7...v0.8
+[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.8}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: ghps
-Version: 0.6
+Version: 0.8
 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.8
 Author: Sepand Haghighi
 Author-email: me@sepand.tech
 License: MIT
@@ -11,7 +11,6 @@ Project-URL: Source, https://github.com/sepandhaghighi/ghps
 Keywords: github gh-pages static-server static-hosting development server local http simulator testing cli python
 Classifier: Development Status :: 4 - Beta
 Classifier: Natural Language :: English
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Environment :: Console
 Classifier: Programming Language :: Python :: 3.7
@@ -22,6 +21,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Education
 Classifier: Topic :: Utilities
@@ -33,6 +33,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: AUTHORS.md
 Requires-Dist: art>=5.3
+Requires-Dist: tomli>=2.0.2
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -62,7 +63,7 @@ Dynamic: summary
 ## Overview	
 
 <p align="justify">		
-<b>Ghps</b> is a minimal, zero-dependency GitHub Pages simulator written in pure Python for local development and testing. It accurately replicates GitHub Pages' static hosting behavior, including proper <code>404.html</code> handling, project base path simulation, strict routing mode, and optional cache control - all while remaining lightweight, fast, and usable both as a CLI tool and as an importable Python library.
+<b>Ghps</b> is a minimal GitHub Pages simulator written in pure Python for local development and testing. It accurately replicates GitHub Pages' static hosting behavior, including proper <code>404.html</code> handling, project base path simulation, strict routing mode, and optional cache control - all while remaining lightweight, fast, and usable both as a CLI tool and as an importable Python library.
 </p>
 
 <table>
@@ -101,13 +102,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.8](https://github.com/sepandhaghighi/ghps/archive/v0.8.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.8`						
 
 
 ## Usage
@@ -117,13 +118,15 @@ 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 |
 |--------|-------------|----------|
+| `-c, --config` | Path to configuration file | Auto discovers `.ghps` |
+| `--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`) | `""` |
@@ -132,8 +135,16 @@ ghps --port=8080 --no-cache --no-threaded
 | `--no-threaded` | Disable threaded server | Threaded enabled |
 | `--auto-open` | Automatically open the server URL | Disable |
 | `--directory-listing` | Enable directory listing | Disable |
+| `--quiet` | Suppress informational server output | 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`.
+
+> [!NOTE]
+> Ghps automatically looks for a `.ghps` configuration file in the served directory if available, or you can specify a custom configuration file path using `-c` / `--config`.
 
 
 ### Library
@@ -141,17 +152,23 @@ ghps --port=8080 --no-cache --no-threaded
 ```python
 from ghps import GHPageServer
 
-server = GHPageServer(
+server1 = GHPageServer(
     directory="dist",
+    host="localhost",
     port=5000,
     base_path="/repo-name",
     strict=True,
     no_cache=False,
     threaded=True,
-	auto_open=True,
+    auto_open=True,
+    quiet=False,
 )
 
-server.start()
+server1.start()
+
+server2 = GHPageServer.from_config(config="config.toml")
+
+server2.start()
 ```
 
 #### Parameters
@@ -159,6 +176,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` |
@@ -166,8 +184,30 @@ server.start()
 | `threaded` | `bool` | Enable threaded request handling | `True` |
 | `auto_open` | `bool` | Automatically open the server URL | `False` |
 | `directory_listing` | `bool` | Enable directory listing | `False` |
+| `quiet` | `bool` | Suppress informational server output | `False` |
+
+> [!NOTE]
+> You can set `port=0` to let the OS automatically select an available port.
 
-ℹ️ 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"`.
+
+### Configuration File
+
+You can define your server settings in a **TOML** configuration file (typically named `.ghps`):
+
+```toml
+directory = "dist"
+host = "localhost"
+port = 8080
+base_path = "/repo-name"
+strict = true
+no_cache = false
+threaded = true
+auto_open = false
+directory_listing = false
+quiet = false
+```
 
 ## Issues & Bug Reports			
 
@@ -218,6 +258,24 @@ 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.8] - 2026-11-08
+### Added
+- `quiet` parameter
+- `--quiet` CLI argument
+- `--config` CLI argument
+- `from_config` method
+### Changed
+- Test system modified
+- Build system modified
+- `Python 3.15` added to `test.yml`
+- `README.md` updated
+## [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 +323,9 @@ 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.8...dev
+[0.8]: https://github.com/sepandhaghighi/ghps/compare/v0.7...v0.8
+[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.8}/README.md

@@ -11,7 +11,7 @@
 ## Overview	
 
 <p align="justify">		
-<b>Ghps</b> is a minimal, zero-dependency GitHub Pages simulator written in pure Python for local development and testing. It accurately replicates GitHub Pages' static hosting behavior, including proper <code>404.html</code> handling, project base path simulation, strict routing mode, and optional cache control - all while remaining lightweight, fast, and usable both as a CLI tool and as an importable Python library.
+<b>Ghps</b> is a minimal GitHub Pages simulator written in pure Python for local development and testing. It accurately replicates GitHub Pages' static hosting behavior, including proper <code>404.html</code> handling, project base path simulation, strict routing mode, and optional cache control - all while remaining lightweight, fast, and usable both as a CLI tool and as an importable Python library.
 </p>
 
 <table>
@@ -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.8](https://github.com/sepandhaghighi/ghps/archive/v0.8.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.8`						
 
 
 ## Usage
@@ -66,13 +66,15 @@ 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 |
 |--------|-------------|----------|
+| `-c, --config` | Path to configuration file | Auto discovers `.ghps` |
+| `--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`) | `""` |
@@ -81,8 +83,16 @@ ghps --port=8080 --no-cache --no-threaded
 | `--no-threaded` | Disable threaded server | Threaded enabled |
 | `--auto-open` | Automatically open the server URL | Disable |
 | `--directory-listing` | Enable directory listing | Disable |
+| `--quiet` | Suppress informational server output | 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`.
+
+> [!NOTE]
+> Ghps automatically looks for a `.ghps` configuration file in the served directory if available, or you can specify a custom configuration file path using `-c` / `--config`.
 
 
 ### Library
@@ -90,17 +100,23 @@ ghps --port=8080 --no-cache --no-threaded
 ```python
 from ghps import GHPageServer
 
-server = GHPageServer(
+server1 = GHPageServer(
     directory="dist",
+    host="localhost",
     port=5000,
     base_path="/repo-name",
     strict=True,
     no_cache=False,
     threaded=True,
-	auto_open=True,
+    auto_open=True,
+    quiet=False,
 )
 
-server.start()
+server1.start()
+
+server2 = GHPageServer.from_config(config="config.toml")
+
+server2.start()
 ```
 
 #### Parameters
@@ -108,6 +124,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` |
@@ -115,8 +132,30 @@ server.start()
 | `threaded` | `bool` | Enable threaded request handling | `True` |
 | `auto_open` | `bool` | Automatically open the server URL | `False` |
 | `directory_listing` | `bool` | Enable directory listing | `False` |
+| `quiet` | `bool` | Suppress informational server output | `False` |
+
+> [!NOTE]
+> You can set `port=0` to let the OS automatically select an available port.
 
-ℹ️ 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"`.
+
+### Configuration File
+
+You can define your server settings in a **TOML** configuration file (typically named `.ghps`):
+
+```toml
+directory = "dist"
+host = "localhost"
+port = 8080
+base_path = "/repo-name"
+strict = true
+no_cache = false
+threaded = true
+auto_open = false
+directory_listing = false
+quiet = false
+```
 
 ## Issues & Bug Reports			
 

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

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

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

@@ -32,55 +32,81 @@ def _parse_args() -> argparse.Namespace:
         help="Version"
     )
 
+    parser.add_argument(
+        "-c", "--config",
+        type=str,
+        default=None,
+        help="Path to configuration file"
+    )
+
+    parser.add_argument(
+        "--host",
+        type=str,
+        default=None,
+        help="Host address to bind to (default: localhost)"
+    )
+
     parser.add_argument(
         "-p", "--port",
         type=int,
-        default=8000,
+        default=None,
         help="Port to serve on (default: 8000, use 0 for automatic allocation)"
     )
 
     parser.add_argument(
         "-d", "--directory",
-        default=".",
+        default=None,
         help="Directory to serve (default: current directory)"
     )
 
     parser.add_argument(
         "-b", "--base-path",
-        default="",
+        default=None,
         help="Base path for project pages (e.g. /repo-name)"
     )
 
     parser.add_argument(
         "--no-strict",
         action="store_true",
+        default=None,
         help="Enable .html fallback"
     )
 
     parser.add_argument(
         "--no-cache",
         action="store_true",
+        default=None,
         help="Disable HTTP caching headers"
     )
 
     parser.add_argument(
         "--no-threaded",
         action="store_true",
+        default=None,
         help="Disable threaded server"
     )
 
     parser.add_argument(
         "--auto-open",
         action="store_true",
+        default=None,
         help="Automatically open the server URL"
     )
 
     parser.add_argument(
         "--directory-listing",
         action="store_true",
+        default=None,
         help="Enable directory listing"
     )
 
+    parser.add_argument(
+        "--quiet",
+        action="store_true",
+        default=None,
+        help="Suppress informational server output"
+    )
+
     args = parser.parse_args()
     return args
 
@@ -92,15 +118,19 @@ def main() -> None:
         if args.version:
             print(GHPS_VERSION)
         else:
-            server = GHPageServer(
+            server = GHPageServer.from_config(
                 directory=args.directory,
+                host=args.host,
                 port=args.port,
                 base_path=args.base_path,
-                strict=not args.no_strict,
+                strict=False if args.no_strict else None,
                 no_cache=args.no_cache,
-                threaded=not args.no_threaded,
+                threaded=False if args.no_threaded else None,
                 auto_open=args.auto_open,
                 directory_listing=args.directory_listing,
+                quiet=args.quiet,
+                config=args.config,
+                auto_discover=True,
             )
             server.start()
     except GHPSError as e:

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

@@ -1,13 +1,14 @@
 # -*- coding: utf-8 -*-
 """ghps params."""
 
-GHPS_VERSION = "0.6"
+GHPS_VERSION = "0.8"
 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."
 
@@ -19,6 +20,11 @@ INVALID_NO_CACHE_TYPE_ERROR = "`no_cache` must be bool."
 INVALID_THREADED_TYPE_ERROR = "`threaded` must be bool."
 INVALID_AUTO_OPEN_TYPE_ERROR = "`auto_open` must be bool."
 INVALID_DIRECTORY_LISTING_TYPE_ERROR = "`directory_listing` must be bool."
+INVALID_QUIET_TYPE_ERROR = "`quiet` must be bool."
+
+INVALID_CONFIG_TYPE_ERROR = "`config` must be str, pathlib.Path, or dict."
+INVALID_CONFIG_FILE_ERROR = "Failed to load config file: {error}"
+INVALID_CONFIG_FORMAT_ERROR = "Config file content must be a valid TOML format."
 
 PORT_IN_USE_ERROR = "`port` is already in use. Try another port or use `0` for automatic allocation."
 PORT_ACCESS_DENIED_ERROR = "`port` access denied. Try a different port or check permissions."