search

ynput / ayon-python-api

Apache License 2.0
8 stars 3 forks source link

Automated api generation #130

Closed iLLiCiTiT closed 2 months ago

iLLiCiTiT commented 5 months ago

Description

This is proposal of how to create public api functions automatically with the same docstrings as ServerAPI has.

Additional information

Added a script file automated_api.py which should be able to fill functions in _api.py based on public functions of ServerAPI with the same docstrings, and also fill imports of the functions in __init__.py. First iteration did also fill the same args, kwargs but I've hit an issue when default value was _PLACEHOLDER object which caused issues.

antirotor commented 2 months ago

It could also use some docstring and package level docstring explaining what it should do.