Skip to content

Rename the import statements "from Toolbox" to make it clear that these are imports from TiMBA Charts #16

Description

@paulrougieux

Current status

The package is currently on pypi at https://pypi.org/project/TiMBA-Charts/

Imports statements in https://github.com/TI-Forest-Sector-Modelling/TiMBA_Charts/blob/main/Toolbox/toolbox.py
import from Toolbox :

from Toolbox.classes.import_data import import_pkl_data
from Toolbox.classes.dashboard import DashboardPlotter
from Toolbox.classes.validation_db import Vali_DashboardPlotter

The name of python package doesn't contain underscores "_".

Package and Module Names

"Modules should have short, all-lowercase names. Underscores can be used in the module name if it improves readability. Python packages should also have short, all-lowercase names, although the use of underscores is discouraged."

Proposal

Rename the Toolbox subdirectory that contains the pytthon code to "timbacharts"

from timbacharts.classes.import_data import import_pkl_data
from timbacharts.classes.dashboard import DashboardPlotter
from timbacharts.classes.validation_db import Vali_DashboardPlotter

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions