Skip to content

Conversation

sayalaruano
Copy link
Collaborator

@sayalaruano sayalaruano commented Aug 12, 2025

Tasks to add a new plotly plot in VueCore:

  • Create Pydantic schema in the vuecore/schemas folder. It should be aligned with the plotly API
  • Create a script with a build function in the vuecore/engines/plotly folder
  • Update theming.py script in the vuecore/engines/plotly folder
  • Register the new builder in the __init__.py script of the vuecore/engines/plotly folder
  • Create a script with the user-facing function in the vuecore/plots folder. It gathers the Pydantic schema, builder function, and saves the plot
  • Create an api example jupyter notebook in the docs/api_examples folder
  • Use jupytext to sync the Jupyter notebook with a Python script
  • Update index.md file in the docs folder with the new example
  • Create test script in the /test folder with the code from the example

@sayalaruano sayalaruano requested a review from enryH August 13, 2025 07:38
Copy link
Collaborator

@enryH enryH left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good. Maybe a test checking that all of our parameters are still present in the plotly equivalent function could be good.

@sayalaruano sayalaruano merged commit 63b4752 into main Aug 13, 2025
8 checks passed
@sayalaruano sayalaruano deleted the lineplot branch August 13, 2025 11:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants