Skip to main content
Gathering Interest

How to have better description and examples for Python SDK generated by Pygen?

Related products:Pygen
  • April 21, 2025
  • 3 replies
  • 32 views

Forum|alt.badge.img+1

We are using Pygen to generate Python SDK for our Data Model. Pygen has given us good set of classes and methods which are really helpful. However, descriptions added in this generated SDK are very generic and not that useful. I think the only way to add descriptions and examples are manually doing changes to each classes and methods.

We are planning to use Pygen to create SDK and may generate SDK multiple times based on data model versions. If we put our own descriptions and examples manually then each time new SDK will generated we will loose the descriptions and examples.

Here, descriptions should be applied to all classes, methods, arguments etc.

I believe there should be way to create SDK with relevant descriptions and examples.

Please suggest what needs to be done.

If no approach available then please consider it as a new product idea

3 replies

Anders  Albert
Seasoned Practitioner
Forum|alt.badge.img
  • Seasoned Practitioner
  • April 22, 2025

Pygen uses the description from the view and properties for the data classes and method descriptions it generates. Are you using those in your data model? I am referring to this in the API:

 

 


Forum|alt.badge.img+1
  • Author
  • Committed
  • April 22, 2025

Pygen uses the description from the view and properties for the data classes and method descriptions it generates. Are you using those in your data model? I am referring to this in the API:

 

 

Sorry for confusion. By descriptions I meant like these
 

Here, all are simple description of arguments and example is not exactly correct. So if I have to change it then I will have to change it manually.


Anders  Albert
Seasoned Practitioner
Forum|alt.badge.img
  • Seasoned Practitioner
  • April 22, 2025

Thanks for the clarification. I will note it as a feature request, will require some thinking 🙂