Fix setup.py and export public functions

README.md

@@ -44,8 +44,8 @@ Inputs must have datatypes as defined in `src/smart_building_rating_calculator/i
 Example of how to call `sbr_score` in python:
 
 ```ruby
-from src.smart_building_rating_calculator.calculate_sbr_score import sbr_score
-from src.smart_building_rating_calculator.inputs import (
+from smart_building_rating_calculator.calculate_sbr_score import sbr_score
+from smart_building_rating_calculator.inputs import (
     BatterySize,
     EVChargerPower,
     HeatingSource,

setup.py

@@ -1,4 +1,4 @@
-from setuptools import setup
+from setuptools import find_packages, setup
 
 setup(
     name="smart-buildings-rating-calculator",
@@ -9,10 +9,14 @@
     long_description_content_type="text/markdown",
     url="https://github.com/centrefornetzero/smart-building-rating-calculator",
     package_dir={"": "src"},
+    packages=find_packages(where="src"),
+    install_requires=[
+        "pandas",
+    ],
     classifiers=[
         "Programming Language :: Python :: 3",
         "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
     ],
-    python_requires="==3.11",
+    python_requires=">=3.11",
 )

src/smart_building_rating_calculator/__init__.py

@@ -0,0 +1,17 @@
+from .calculate_sbr_score import sbr_score
+from .inputs import (
+    BatterySize,
+    EVChargerPower,
+    HeatingSource,
+    HotWaterSource,
+    SolarInverterSize,
+)
+
+__all__ = [
+    "sbr_score",
+    "BatterySize",
+    "EVChargerPower",
+    "HeatingSource",
+    "HotWaterSource",
+    "SolarInverterSize",
+]

src/smart_building_rating_calculator/calculate_sbr_score.py

@@ -2,17 +2,17 @@
 
 import pandas as pd
 
-from src.smart_building_rating_calculator.flex_archetype import calc_flex_archetype
-from src.smart_building_rating_calculator.initiate_user_inputs import prep_user_inputs
-from src.smart_building_rating_calculator.inputs import (
+from smart_building_rating_calculator.flex_archetype import calc_flex_archetype
+from smart_building_rating_calculator.initiate_user_inputs import prep_user_inputs
+from smart_building_rating_calculator.inputs import (
     BatterySize,
     EVChargerPower,
     HeatingSource,
     HotWaterSource,
     SolarInverterSize,
     UserInputs,
 )
-from src.smart_building_rating_calculator.intermediate_scoring import calc_sbr_score
+from smart_building_rating_calculator.intermediate_scoring import calc_sbr_score
 
 
 def calc_sbr(sbr_val: float) -> str:

src/smart_building_rating_calculator/flex_archetype.py

@@ -2,8 +2,8 @@
 Based on Andy's calcuations, this module calculates the flex archetype of a building based on the user inputs and the SBR value.
 """
 
-from src.smart_building_rating_calculator.flexer_enums import FlexArchetype
-from src.smart_building_rating_calculator.inputs import (
+from smart_building_rating_calculator.flexer_enums import FlexArchetype
+from smart_building_rating_calculator.inputs import (
     HeatingSource,
     HotWaterSource,
     UserInputs,

src/smart_building_rating_calculator/initiate_user_inputs.py

@@ -1,4 +1,4 @@
-from src.smart_building_rating_calculator.inputs import (
+from smart_building_rating_calculator.inputs import (
     BatterySize,
     EVChargerPower,
     HeatingSource,

src/smart_building_rating_calculator/intermediate_scoring.py

@@ -1,7 +1,7 @@
 from dataclasses import replace
 from typing import List
 
-from src.smart_building_rating_calculator.inputs import (
+from smart_building_rating_calculator.inputs import (
     BatterySize,
     EVChargerPower,
     HeatingSource,

tests/test_sbr_calculator.py

@@ -5,21 +5,21 @@
 
 import pytest
 
-from src.smart_building_rating_calculator.calculate_sbr_score import (
+from smart_building_rating_calculator.calculate_sbr_score import (
     get_sbr_scores,
     sbr_score,
 )
-from src.smart_building_rating_calculator.flex_archetype import FlexArchetype
-from src.smart_building_rating_calculator.initiate_user_inputs import prep_user_inputs
-from src.smart_building_rating_calculator.inputs import (
+from smart_building_rating_calculator.flex_archetype import FlexArchetype
+from smart_building_rating_calculator.initiate_user_inputs import prep_user_inputs
+from smart_building_rating_calculator.inputs import (
     BatterySize,
     EVChargerPower,
     HeatingSource,
     HotWaterSource,
     SolarInverterSize,
     UserInputs,
 )
-from src.smart_building_rating_calculator.intermediate_scoring import (
+from smart_building_rating_calculator.intermediate_scoring import (
     calc_alternative_heating_score,
     calc_alternative_hot_water_score,
     calc_elec_heating_score,