SFTtech / SFTtech/openage

example for c++ <-> python glue code

Open
#1,216 3 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation improvement lang: cython
Dominant language
Python
Stars
14.4k
Forks
1.3k
PR merge metrics
No merged PRs in 30d

Description

We wrote a cpp/pyinterface using Cython. We have a documentation for that in doc/code/pyinterface.md.

This should be enhanced though, and should especially add a concrete example of adding a new module for both the py->cpp direction and cpp->py.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading doc/code/pyinterface.md to understand the existing Cython documentation and its current coverage. Add concrete examples showing how to create a new module in both the Python-to-C++ and C++-to-Python directions. The documentation is complete when both workflows are illustrated clearly for readers.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.