Skip to content

Core and Helpers folder overlap #30

@PaoloLeonard

Description

@PaoloLeonard

Is your feature request related to a problem? Please describe.
It seems that core and helpers folders module are serving similar purposes. Can we define what should go in helpers and what should go in core?

Describe the solution you'd like

#Core Module

This module should contain the primary functionality of your library. Think of it as the "engine." It houses:

  • Main Classes & Objects: The central data structures or models (e.g., DataFrame, Request).
  • Core Functions: The essential operations your library performs (e.g., calculate_mean(), send_email()).
  • Public API: What users directly import and interact with.
  • Key Business Logic: The algorithms defining your library's main behavior.

#Helpers module

This module should contain utility functions that support the core but aren't central to its main purpose. These are your "tools":

  • Utility Functions: Small, reusable tasks (e.g., format_date(), validate_email()).
  • Common Data Transformations: Functions that prepare data for core operations.
  • Internal Support: Functions called by the core, generally not for direct external use.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions