search

microsoft / yardl

Tooling for streaming instrument data
https://microsoft.github.io/yardl/
MIT License
29 stars 5 forks source link

generate `setup.py` or similar #108

Open KrisThielemans opened 7 months ago

KrisThielemans commented 7 months ago

It'd make sense to be able to install generated python.

naegelejd commented 1 month ago

Hi Kris,

There are many methods for describing and building installable Python packages. The current best practice is to write a pyproject.toml file describing the project and specifying a "build backend", such as Setuptools or Hatchling. However, almost all of the information needed in a setup.py or pyproject.toml file is independent of the Yardl model (e.g. project name, version, license, readme, classifiers, URLs, etc.). Does it make sense for Yardl to generate that file if most of it has to be manually updated and maintained by the author?

We just released MRD 2.0.0, the new version of the ISMRM Raw Data format, which uses Yardl. You can see how I set up the Python packaging files adjacent to the generated mrd Python code here: https://github.com/ismrmrd/mrd/tree/main/python.