datamole-ai / edvart

An open-source Python library for Data Scientists & Data Analysts designed to simplify the exploratory data analysis process. Using Edvart, you can explore data sets and generate reports with minimal coding.
https://datamole-ai.github.io/edvart/
MIT License
48 stars 7 forks source link

refactor!: config dataclasses #120

Closed lukany closed 1 year ago

lukany commented 1 year ago

BREAKING_CHANGE: TODO

Closes #122

lukany commented 1 year ago

Blocked by https://github.com/datamole-ai/edvart/pull/119 which unifies interface of .add_... methods and section __init__()s

lukany commented 1 year ago

@mbelak-dtml Would you please review this draft? I would like to have the design approved before proceeding with creating more dataclasses.

mbelak-dtml commented 1 year ago

Hi @lukany, IMHO introduction of config classes would make the API less user-friendly by adding an extra step in configuring of the sections. I understand the simplification of the code base by removing duplicate parameters, but IMO this is not a big issue and not worth the added complication for the user. Additionally, with https://github.com/datamole-ai/edvart/issues/36 (addition of a generic Report.add_section), we could remove the add_<section> methods of Report, removing the duplicated parameters.

lukany commented 1 year ago

Hi @lukany, IMHO introduction of config classes would make the API less user-friendly by adding an extra step in configuring of the sections. I understand the simplification of the code base by removing duplicate parameters, but IMO this is not a big issue and not worth the added complication for the user. Additionally, with #36 (addition of a generic Report.add_section), we could remove the add_<section> methods of Report, removing the duplicated parameters.

Agree. Closing this PR.