docs: surface the ifclite-geom Python wheel in README + docs site#1326
Conversation
The native Python wheel (ifclite-geom) had no entry point from the project's main docs surfaces. Add: - docs/api/python.md: a Python API Reference page (install, both functions, output schema, notes) wired into the mkdocs nav under API Reference. - README "Choose your setup": a Python (native wheel) row. - README "Documentation" API row: a Python link. Links target the hosted docs page (ltplus-ag.github.io/ifc-lite/api/python/), matching the existing TypeScript / Rust / WASM entries.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
2 Skipped Deployments
|
|
Warning Review limit reached
More reviews will be available in 10 minutes and 13 seconds. Learn how PR review limits work. Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file). ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits. 🚦 How do rate limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate. For paid Pro and Pro+ PR reviews, CodeRabbit uses rolling per-developer review limits. Reviews become available again as older review attempts age out of the rolling limit window. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 85f10cf19f
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| for step_id, el in data["elements"].items(): | ||
| verts = np.frombuffer(el["vertices"], dtype=np.float64).reshape(-1, 3) | ||
| faces = np.frombuffer(el["faces"], dtype=np.uint32 ).reshape(-1, 3) | ||
| print(step_id, el["ifc_type"], el["global_id"], verts.shape, faces.shape) |
There was a problem hiding this comment.
In the buffer path shown here, geometry_data_buffers() builds each element dict with only ifc_type, color, vertices, and faces in rust/python/src/lib.rs, and never inserts global_id or name. For any model, copy-pasting this quick start raises KeyError: 'global_id' before it can print the mesh shapes; either switch the example to the JSON API for metadata or add these fields to the buffer binding/docs.
Useful? React with 👍 / 👎.
1 participant
Why
The native Python wheel (
ifclite-geom) had no entry point from the project's main discovery surfaces: the root README and the hosted docs site only mention the npm packages and Rust crates. Anyone who finds the wheel on PyPI (or hears about it) has nowhere on the site to land. This is the "reach" follow-up to #1325 (the package-level README + examples + stub).What
docs/api/python.md— a Python API Reference page (install, both functions, output schema, notes, links to examples + source), wired into the mkdocs nav under API Reference alongside TypeScript / Rust / WASM.Python (native wheel)row.Pythonlink.All links point at the hosted page
https://ltplus-ag.github.io/ifc-lite/api/python/, matching the existing API entries.Notes
global_id/nameAPI addition.Related
Pairs with #1325. Together they give a
pipuser a documentation URL to land on (the original request that prompted this).