search

DrMarkusVoss / pumla

pumla - systematic re-use of model elements described with PlantUML
GNU General Public License v3.0
102 stars 10 forks source link

Package as proper python package #1

Closed janbernloehr closed 3 years ago

janbernloehr commented 3 years ago

If we follow the python packaging guide, then pumla can be easily installed using pip and distributed as a wheel. The latter allows to upload it to pypi and simply install it by pip install pumla.

Moreover, this would make pumla feel look and feel like other python packages easing contributions.

DrMarkusVoss commented 3 years ago

As pumla relies heavily on PlantUML, and the Python command line tool is only one aspect of the solution, the other is the Preprocessor macros for PlantUML, I am not sure whether it would raise wrong expectations. At least then I should provide an install function that automatically downloads the proper PlantUML version and also trigger the rendering of the diagrams via puma.py.

DrMarkusVoss commented 3 years ago

But organizing the repo like that makes sense even when I do not put it on the python package index I guess.

janbernloehr commented 3 years ago

Sure. From my pov, pip install pumla should only install the cli and make it available. We can add a check if plantuml is installed and provide a link installation instructions if it is missing but I would not do that during pip install.

DrMarkusVoss commented 3 years ago

updated doc and examples and merged #3 to fix the issue. :-) thank you for your effort @janbernloehr