pybind / pybind/scikit_build_example
Beginner freindlyness
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 148
- Forks
- 39
- Avg merge
- 8d 2h
- Merged PRs (30d)
- 1
Description
Hi there, I found this repo when I was deciding on how to port some C++ code to python.
I used to go the way via described in the cmake_example, but after watching @henryiii 's talk from SciPy22 I thought about scikit_build_example would be worth a try.
However, I find it quite hard to understand what the (minimum) necessary components are and how this example works, especially since new/unknown/fancy tools like nox and ruff are used.
For example in this file a beginner wonders if the imports from future are necessary. Comments would be helpful there as well as in the CMakeLists.txt where one can not assume that beginners know where SKBUILD_PROJECT_NAME etc. come from.
Please don't get me wrong, I appreciate this project. I just think it needs a bit more documentation to be really usable for a broader audience
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with src/scikit_build_example/init.py and CMakeLists.txt, then review how the scikit_build_example is presented alongside cmake_example. Clarify which components are necessary and explain the future imports, SKBUILD_PROJECT_NAME, and the roles of nox and ruff. Done means a beginner can follow the example without needing to infer what these tools and settings provide.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cmake, python
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100