InsightSoftwareConsortium / InsightSoftwareConsortium/ITKSoftwareGuide

Add a Python style guide

Open
#118 0 comments 1 reaction 0 assignees View on GitHub
type:Enhancement
Dominant language
TeX
Stars
35
Forks
18
PR merge metrics
No merged PRs in 30d

Description

Add a Python style guide.

The [System Overview Wrapping](https://github.com/InsightSoftwareConsortium/ITKSoftwareGuide/blob/bf60afa4274dc5c285ac5c8b173a440866def9c8/SoftwareGuide/Latex/Architecture/SystemOverview.tex#L755) section contains [some example code](https://github.com/InsightSoftwareConsortium/ITKSoftwareGuide/blob/bf60afa4274dc5c285ac5c8b173a440866def9c8/SoftwareGuide/Latex/Architecture/SystemOverview.tex#L792) of what an ITK Python code looks like, but we are lacking some guidelines on how to write proper ITK software using Python.

Besides, ITK supports more than one syntax or interface, and the [ITKExamples](https://itk.org/ITKExamples/) seem not to have converged to one yet.

We should may be provide an overview and encourage using one.

Also, given the importance of the Python wrappers, the Python section may need further refactoring.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.