tezos-reward-distributor-organization / tezos-reward-distributor

Tezos Reward Distributor (TRD): A reward distribution software for tezos bakers.
https://tezos-reward-distributor-organization.github.io/tezos-reward-distributor/
GNU General Public License v3.0
87 stars 50 forks source link

Plugin system for custom reporting needs #62

Open habanoz opened 5 years ago

habanoz commented 5 years ago

Is your feature request related to a problem? Please describe. Having a plugin system for custom reporting needs.

Describe the solution you'd like Users have custom reporting needs, i.e. users look at different variables, different layouts are preferred. Plugin system can let users have their reports tailored for their needs. Plugins can be loaded from a plugin directory. Users put their plugins to the plugin directory and application executes the plugin.

Additional context RewadLog model which is planned with #54 is useful for custom reporting.

jdsika commented 5 years ago

Related to #12 and the question of storing the basic payment information in a DB. The same DB could be enriched with additional information and be used by a reporting tool?

habanoz commented 5 years ago

Every user may need a separate report format. Users can be given tools to determine their report content. Currently a CSV file is created. As an extension users may wish to create html files, xml files json files etc. Content of the report file should be left to users' choices. For example a user can provide a template file and trd creates reports according to that template.

This does not require an underlying DB. Reports are created at payment time and information is available to future-reporting-sub-system.

jdsika commented 4 years ago

I believe that the CSV files are not a very good source and we should pick this up after #242 is the "single point of truth" in the system with enough quality gates included.