-
Notifications
You must be signed in to change notification settings - Fork 3
Add template for Python interface generation #86
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Add template for Python interface generation #86
Conversation
Co-authored-by: José Grilo <jose.grilo@research.fchampalimaud.org>
Co-authored-by: José Grilo <jose.grilo@research.fchampalimaud.org>
Co-authored-by: José Grilo <jose.grilo@research.fchampalimaud.org>
Co-authored-by: José Grilo <jose.grilo@research.fchampalimaud.org>
|
@MicBoucinha I need more context before being able to review this, there are simply too many architectural decisions here which I do not know about. Can we schedule a slot in the Harp SCM so you can present and discuss this proposal please? |
|
Sure thing, just let us know when would be the best time for that. |
Co-authored-by: José Grilo <jose.grilo@research.fchampalimaud.org>
Co-authored-by: José Grilo <jose.grilo@research.fchampalimaud.org>
Co-authored-by: José Grilo <jose.grilo@research.fchampalimaud.org>
Co-authored-by: José Grilo <jose.grilo@research.fchampalimaud.org>
Co-authored-by: José Grilo <jose.grilo@research.fchampalimaud.org>
|
Hi! We have made the following changes to the python interface generation:
Feel free to give us feedback where improvements can be done. |
Co-authored-by: José Grilo <jose.grilo@research.fchampalimaud.org>
- Update package build backend - Update examples documentation generation Co-authored-by: José Grilo <jose.grilo@research.fchampalimaud.org>
PR changes
This PR introduces automatic generation of the Python interface for a device.
The base template used is a variation of https://github.com/fpgmaas/cookiecutter-uv.
The chosen python package structure is as follows:
This PR is related to PR#3 of the
pyharprepository due to PEP420 compliance for namespace packages, since we want to have a single namespace package forharprelated packages.The generated Python interface is a direct access type of interface, which means it provides a direct mapping to the device's functionality.
The package also includes a MKDocs configuration for documentation generation, focusing currently on the API documentation. The final documentation is available at https://fchampalimaud.github.io/pyharp/, which aggregates the documentation for the
pyharppackage and all devices under theharp.devicesrepository, currently available here: https://github.com/fchampalimaud/harp.devices.