cppmanlite 0.1.0__py3-none-any.whl

cppmanlite-0.1.0.dist-info/METADATA

@@ -0,0 +1,112 @@
+Metadata-Version: 2.4
+Name: cppmanlite
+Version: 0.1.0
+Summary: Lightweight serverless C++ documentation lookup — pure Python, no C deps
+License-Expression: MIT
+Project-URL: Homepage, https://dive4dec.github.io/cppmanlite/
+Project-URL: Repository, https://github.com/dive4dec/cppmanlite
+Keywords: cpp,cplusplus,cppreference,documentation,cppman
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Utilities
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Dynamic: license-file
+
+# cppmanlite
+
+Lightweight serverless C++ documentation lookup — a pure Python package and
+static site powered by [cppreference.com](https://en.cppreference.com).
+
+## Features
+
+- **Pure Python** — no C dependencies, works in CPython, Pyodide, Jupyter
+- **Static site** — served from GitHub Pages or any static host
+- **Client-side search** — lunr.js fuzzy search over a ~1MB index
+- **On-demand page loading** — fetches from cppreference.com or local bundle
+- **Auto-updating** — GitHub Action refreshes the index monthly
+- **Kubernetes-ready** — Helm chart included for `/cppmanlite` route
+
+## Python package
+
+```bash
+pip install cppmanlite
+```
+
+```python
+import cppmanlite
+
+# Search for C++ documentation
+cppmanlite.search("vector")
+# [{'title': 'std::vector', 'url': 'cpp/container/vector.html', ...}, ...]
+
+# Display a page (renders HTML in Jupyter, plain text in terminal)
+cppmanlite.man("std::vector")
+
+# Alias
+cppmanlite.help("sort")
+```
+
+Works in [Pyodide](https://pyodide.org) (Python in the browser) — no compiled
+dependencies required.
+
+## Static site
+
+The `site/` directory contains a standalone search UI:
+
+- `index.html` — search box + results + page reader
+- `app.js` — lunr.js search + on-demand page fetching
+- `style.css` — dark/light theme
+
+Deployed to GitHub Pages at: **https://dive4dec.github.io/cppmanlite/**
+
+## Docker / Kubernetes
+
+```bash
+docker build -t cppmanlite:v1 .
+```
+
+Multi-stage build: downloads the cppreference HTML archive, strips boilerplate,
+builds a search index, and serves everything via nginx.
+
+```bash
+helm install cppmanlite ./chart -n cppmanlite
+```
+
+Serves at `https://socratic.cs.cityu.edu.hk/cppmanlite/`
+
+## How it works
+
+1. **Index building** (`scripts/build_index.py`): Downloads the cppreference
+   HTML book archive, extracts page titles + snippets, fixes relative URLs,
+   and writes a compact JSON index (~1.2MB for 6,000+ pages).
+
+2. **Search**: lunr.js builds a client-side full-text search index from the
+   JSON. Results show title, URL path, and a content snippet.
+
+3. **Page reading**: When a user clicks a result, the reader fetches the page
+   — either from a local `docs/` bundle (Docker/K8s deployment) or directly
+   from cppreference.com (GitHub Pages).
+
+4. **Auto-update**: A GitHub Action runs monthly, downloads the latest
+   cppreference archive, rebuilds the index, and deploys to GitHub Pages.
+
+## Data source
+
+Documentation from [cppreference.com](https://en.cppreference.com), licensed
+under CC-BY-SA 3.0 / GFDL. The HTML book archive is published by
+[PeterFeicht/cppreference-doc](https://github.com/PeterFeicht/cppreference-doc).
+
+## License
+
+MIT — see [LICENSE](LICENSE).

cppmanlite-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+cppmanlite/__init__.py,sha256=s1fKiT1u8yGOjIFXzmoBCvD-4zSNyeAA7jfzlN4Jtus,677
+cppmanlite/core.py,sha256=fx_K4eDi-wqDQz0UlK87QV7unW1DpBOOjM1v-0brmg8,9327
+cppmanlite/data/index.json,sha256=ErhTI8HTwsg48nmtOUd7c-oQYYf5J7MkY9i7OrFRdb0,1320331
+cppmanlite-0.1.0.dist-info/licenses/LICENSE,sha256=l2oOhGEO85UPMUiHAgK3C4t3OP8J2KMTQ5FuKFwSVmg,1065
+cppmanlite-0.1.0.dist-info/METADATA,sha256=qHPbrlKCEwECcplv92uXqxWT15HngUJlDu20TPgH81s,3701
+cppmanlite-0.1.0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+cppmanlite-0.1.0.dist-info/top_level.txt,sha256=-bCcaOyJMo5gnAKJ1i1l_eaLeK20NnVsHG_4K3YZ7Dw,11
+cppmanlite-0.1.0.dist-info/RECORD,,

cppmanlite-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (83.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

cppmanlite-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 dive4dec
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

cppmanlite-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+cppmanlite