A fast, keyboard-driven TUI API client & webhook inspector. No cloud, no Electron, 100% local-first.
release(v0.1.1): publish to PyPI and update documentation
4yk5f789efb3c052
diff --git a/README.md b/README.mdnew file mode 100644index 0000000..5698ce4--- /dev/null+++ b/README.md@@ -0,0 +1,133 @@+```+ ____ _ _+ / ___| |__ ___ ___| |_ _ __ ___ __ _ _ __+ | | _| '_ \ / _ \/ __| __| '_ ` _ \ / _` | '_ \+ | |_| | | | | (_) \__ \ |_| | | | | | (_| | | | |+ \____|_| |_|\___/|___/\__|_| |_| |_|\__,_|_| |_|++```++# Ghostman π»++> **A fast, keyboard-driven terminal API client and webhook inspector.**+> *No mandatory cloud accounts. No 1GB Electron bloat. 100% local-first.*++[](https://pypi.org/project/ghostman/)+[](LICENSE)+[](https://www.python.org/)+[](https://github.com/Textualize/textual)++<p align="center">+ <img src="assets/ghostman-main.svg" alt="Ghostman Terminal Studio" width="100%">+</p>++---++## π‘ Why Ghostman?++Modern API clients (Postman, Insomnia) started as simple developer utilities, but evolved into heavy enterprise platforms:++- β **Bloated Memory:** Postman idles at **800MB β 1.5GB of RAM** just sitting in the background.+ π **Ghostman runs on ~30MB of RAM.**+- β **Mandatory Cloud Lock-in:** Forced account sign-ins, team workspaces, and cloud syncing for private test requests.+ π **Ghostman is 100% local-first.** Your requests and collections stay as plain JSON/YAML on your disk (`~/.ghostman/`).+- β **Sluggish Startup:** 5 to 10 seconds of splash screens and loading spinners.+ π **Ghostman cold boots in ~150ms** directly inside your terminal.+- β **External Webhook Tunnels:** Needing ngrok, webhook.site, or third-party accounts just to inspect a local webhook payload.+ π **Ghostman has a built-in webhook listener** on port 9090 (`Ctrl + W`).+- β **Mouse-Heavy Navigation:** Constant clicking between dropdowns, sidebars, and nested dialogs.+ π **Keyboard-driven workflows.** Send with `Ctrl + S`, save with `Ctrl + K`, new request with `Ctrl + N`.++---++## πΈ Interface Tour++### 1. High-Speed Telemetry & Formatted Responses+Instant latency tracking in milliseconds, HTTP status badges, payload size metrics, and syntax-highlighted JSON rendering:++<p align="center">+ <img src="assets/ghostman-response.svg" alt="Response Telemetry" width="100%">+</p>++### 2. Live Webhook Stream+Catch incoming HTTP callbacks from Stripe, GitHub, Shopify, or local microservices in real-time without leaving your terminal:++<p align="center">+ <img src="assets/ghostman-webhook.svg" alt="Live Webhooks" width="100%">+</p>++---++## β‘ Core Features++- **Full HTTP Method Suite:** Seamlessly compose `GET`, `POST`, `PUT`, `DELETE`, and `PATCH` requests.+- **Performance Telemetry:** DNS + TTFB latency in real-time to monitor endpoint bottlenecks.+- **Embedded Webhook Server:** Spin up a local server on port 9090 with one shortcut to catch incoming hooks.+- **Zero Cloud Dependency:** Save collections as plain files in `.ghostman/` and commit them to Git.+- **Auto-Formatting:** Automatically indents and formats JSON payloads with Rich syntax coloring.+- **Cyberpunk Dark Theme:** Designed for readability in terminal environments with solid borders.++---++## π Quick Start++### Installation++#### Option 1: Via pip (Recommended)+```bash+pip install ghostman+ghostman+```++#### Option 2: From Source+```bash+# 1. Clone the repository+git clone https://github.com/4yk5/Ghostman.git+cd Ghostman++# 2. Install dependencies+pip install -r requirements.txt++# 3. Launch Ghostman+python main.py+```++> **Windows tip:** You can also run Ghostman by double-clicking `run.bat` in the project root!++---++## β¨οΈ Keyboard Shortcuts++| Keybinding | Action |+| :--- | :--- |+| `Ctrl + S` | **Send HTTP Request** (Executes call and switches to Response view) |+| `Ctrl + K` | **Save Request** (Saves current endpoint to collections) |+| `Ctrl + N` | **New Request** (Resets input fields) |+| `Ctrl + W` | **Toggle Webhook Server** (Starts / Stops listener on port 9090) |+| `Tab` / `Shift + Tab` | Navigate between inputs, method selector, and tabs |+| `Enter` | Select endpoint from sidebar / trigger button |+| `Ctrl + Q` | **Quit Ghostman** |++---++## π οΈ Testing Webhooks Locally++1. Press `Ctrl + W` to start the listener on port `9090`.+2. Send a test webhook from another terminal:+ ```bash+ curl -X POST http://127.0.0.1:9090/webhook \+ -H "Content-Type: application/json" \+ -d '{"event": "payment_succeeded", "amount": 4200}'+ ```+3. Switch to the **Live Webhooks** tab to inspect headers, timestamp, and payload.+4. Click any captured webhook to load its payload directly into the editor.++---++## π€ Contributing++Contributions, feedback, and pull requests are very welcome! Feel free to open an issue for bug reports or feature requests.++## π License++Released under the [MIT License](LICENSE).diff --git a/pyproject.toml b/pyproject.tomlnew file mode 100644index 0000000..efa71a6--- /dev/null+++ b/pyproject.toml@@ -0,0 +1,40 @@+[build-system]+requires = ["setuptools>=61.0"]+build-backend = "setuptools.build_meta"++[project]+name = "ghostman"+version = "0.1.1"+description = "A fast, keyboard-driven terminal API client and webhook inspector"+readme = "README.md"+authors = [{ name = "4yk5" }]+license = { text = "MIT" }+requires-python = ">=3.10"+keywords = ["api", "tui", "terminal", "webhook", "postman", "rest", "http"]+classifiers = [+ "Programming Language :: Python :: 3",+ "License :: OSI Approved :: MIT License",+ "Operating System :: OS Independent",+ "Environment :: Console",+ "Topic :: Internet :: WWW/HTTP",+ "Topic :: Software Development :: Testing",+]+dependencies = [+ "textual>=8.0.0",+ "httpx>=0.28.0",+ "rich>=14.0.0",+]++[project.urls]+Homepage = "https://github.com/4yk5/Ghostman"+Repository = "https://github.com/4yk5/Ghostman"+Issues = "https://github.com/4yk5/Ghostman/issues"++[project.scripts]+ghostman = "main:main"++[tool.setuptools.package-data]+"*" = ["styles.tcss"]++[tool.setuptools]+py-modules = ["app", "main", "network", "storage", "webhook_server"]