ghps

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 12 Open GitHub ↗

Ghps: A Minimal GitHub Pages Simulator for Local Development

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">
<img src="https://github.com/sepandhaghighi/ghps/raw/main/otherfiles/logo.png" width="300">
<h1>Ghps: A Minimal GitHub Pages Simulator for Local Development</h1>
<br/>
<a href="https://www.python.org/"><img src="https://img.shields.io/badge/built%20with-Python3-green.svg" alt="built with Python3"></a>
<a href="https://github.com/sepandhaghighi/ghps"><img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/sepandhaghighi/ghps"></a>
<a href="https://badge.fury.io/py/ghps"><img src="https://badge.fury.io/py/ghps.svg" alt="PyPI version"></a>
<a href="https://codecov.io/gh/sepandhaghighi/ghps"><img src="https://codecov.io/gh/sepandhaghighi/ghps/graph/badge.svg?token=X9Yj0YSPAK"></a>
</div>			
				
## 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.
</p>

<table>
	<tr>
		<td align="center">PyPI Counter</td>
		<td align="center"><a href="http://pepy.tech/project/ghps"><img src="http://pepy.tech/badge/ghps"></a></td>
	</tr>
	<tr>
		<td align="center">Github Stars</td>
		<td align="center"><a href="https://github.com/sepandhaghighi/ghps"><img src="https://img.shields.io/github/stars/sepandhaghighi/ghps.svg?style=social&label=Stars"></a></td>
	</tr>
</table>

<table>
	<tr> 
		<td align="center">Branch</td>
		<td align="center">main</td>	
		<td align="center">dev</td>	
	</tr>
	<tr>
		<td align="center">CI</td>
		<td align="center"><img src="https://github.com/sepandhaghighi/ghps/actions/workflows/test.yml/badge.svg?branch=main"></td>
		<td align="center"><img src="https://github.com/sepandhaghighi/ghps/actions/workflows/test.yml/badge.svg?branch=dev"></td>
	</tr>
</table>
<table>
    <tr> 
        <td align="center">Code Quality</td>
        <td align="center"><a href="https://www.codefactor.io/repository/github/sepandhaghighi/ghps"><img src="https://www.codefactor.io/repository/github/sepandhaghighi/ghps/badge" alt="CodeFactor"></a></td>
        <td align="center"><a href="https://app.codacy.com/gh/sepandhaghighi/ghps/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade"><img src="https://app.codacy.com/project/badge/Grade/738213c0ed074885b32c531d1bbf003f"></a></td>
    </tr>
</table>

## Installation

### Source Code
- Download [Version 0.5](https://github.com/sepandhaghighi/ghps/archive/v0.5.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.5`

## Usage

Ghps can be used both as a CLI tool and as a Python library.

### CLI

```bash
ghps --port=8080 --no-cache --no-threaded
```

#### Options

| Option | Description | Default |
|--------|-------------|----------|
| `-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`) | `""` |
| `--no-strict` | Enable `.html` fallback| Strict mode enabled |
| `--no-cache` | Disable HTTP caching headers | Cache enabled |
| `--no-threaded` | Disable threaded server | Threaded enabled |
| `--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

### Library

```python
from ghps import GHPageServer

server = GHPageServer(
    directory="dist",
    port=5000,
    base_path="/repo-name",
    strict=True,
    no_cache=False,
    threaded=True,
	auto_open=True,
)

server.start()
```

#### Parameters

| Parameter | Type | Description | Default |
|------------|------|-------------|----------|
| `directory` | `str` | Directory to serve | `"."` |
| `port` | `int` | Port number | `8000` |
| `base_path` | `str` | Base path for project page simulation | `""` |
| `strict` | `bool` | Enforce GitHub-like routing behavior | `True` |
| `no_cache` | `bool` | Disable cache headers | `False` |
| `threaded` | `bool` | Enable threaded request handling | `True` |
| `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

## Issues & Bug Reports

Just fill an issue and describe it. We'll check it ASAP!

- Please complete the issue template

## Show Your Support
								
<h3>Star This Repo</h3>

Give a ⭐️ if this project helped you!

<h3>Donate to Our Project</h3>

<h4>Bitcoin</h4>
1KtNLEEeUbTEK9PdN6Ya3ZAKXaqoKUuxCy
<h4>Ethereum</h4>
0xcD4Db18B6664A9662123D4307B074aE968535388
<h4>Litecoin</h4>
Ldnz5gMcEeV8BAdsyf8FstWDC6uyYR6pgZ
<h4>Doge</h4>
DDUnKpFQbBqLpFVZ9DfuVysBdr249HxVDh
<h4>Tron</h4>
TCZxzPZLcJHr2qR3uPUB1tXB6L3FDSSAx7
<h4>Ripple</h4>
rN7ZuRG7HDGHR5nof8nu5LrsbmSB61V1qq
<h4>Binance Coin</h4>
bnb1zglwcf0ac3d0s2f6ck5kgwvcru4tlctt4p5qef
<h4>Tether</h4>
0xcD4Db18B6664A9662123D4307B074aE968535388
<h4>Dash</h4>
Xd3Yn2qZJ7VE8nbKw2fS98aLxR5M6WUU3s
<h4>Stellar</h4>		
GALPOLPISRHIYHLQER2TLJRGUSZH52RYDK6C3HIU4PSMNAV65Q36EGNL
<h4>Zilliqa</h4>
zil1knmz8zj88cf0exr2ry7nav9elehxfcgqu3c5e5
<h4>Coffeete</h4>
<a href="http://www.coffeete.ir/opensource">
<img src="http://www.coffeete.ir/images/buttons/lemonchiffon.png" style="width:260px;" />
</a>

ghps

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README