refactor: use an uppercase L in EcoLogits (#32)

README.md

@@ -1,7 +1,7 @@
 Ecologits
 ============
 
-**Ecologits** tracks and estimates the energy consumption and environmental impacts of using generative AI models through APIs.
+**EcoLogits** tracks and estimates the energy consumption and environmental impacts of using generative AI models through APIs.
 
 
 ## ⚙️ Installation
@@ -11,10 +11,10 @@ Coming soon...
 ## 🚀 Usage
 
 ```python
-from ecologits import Ecologits
+from ecologits import EcoLogits
 from openai import OpenAI
 
-Ecologits.init()
+EcoLogits.init()
 
 client = OpenAI(
     api_key="<OPENAI_API_KEY>",
@@ -28,12 +28,12 @@ response = client.chat.completions.create(
 )
 
 # Get estimated environmental impacts for that inference.
-print(response.impacts)        # Impacts(energy=0.025, energy_unit='Wh', ...)
+print(response.impacts)  # Impacts(energy=0.025, energy_unit='Wh', ...)
 ```
 
 
 
-See package documentation on [Ecologits](<link-to-mkdocs-material>)
+See package documentation on [EcoLogits](<link-to-mkdocs-material>)
 
 ## 💪 Contributing
 

ecologits/__init__.py

@@ -1,3 +1,3 @@
-from .ecologits import Ecologits
+from .ecologits import EcoLogits
 
-__all__ = ["Ecologits"]
+__all__ = ["EcoLogits"]

ecologits/ecologits.py

@@ -3,15 +3,15 @@
 from ecologits.exceptions import TracerInitializationError
 
 
-class Ecologits:
+class EcoLogits:
     initialized = False
 
     @staticmethod
     def init() -> None:
-        if Ecologits.initialized:
+        if EcoLogits.initialized:
             raise TracerInitializationError()
         init_instruments()
-        Ecologits.initialized = True
+        EcoLogits.initialized = True
 
 
 def init_instruments() -> None:

ecologits/exceptions.py

@@ -1,7 +1,7 @@
-class EcologitsError(Exception):
+class EcoLogitsError(Exception):
     pass
 
 
-class TracerInitializationError(EcologitsError):
+class TracerInitializationError(EcoLogitsError):
     """Tracer is initialized twice"""
     pass

pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "poetry.core.masonry.api"
 [tool.poetry]
 name = "ecologits"
 version = "0.1.0"
-description = "Ecologits tracks and estimates the energy consumption and environmental impacts of using generative AI models through APIs."
+description = "EcoLogits tracks and estimates the energy consumption and environmental impacts of using generative AI models through APIs."
 authors = ["DataForGood"]
 license = "MIT"
 readme = "README.md"

tests/conftest.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-from ecologits import Ecologits
+from ecologits import EcoLogits
 
 
 @pytest.fixture(autouse=True)
@@ -28,4 +28,4 @@ def vcr_config():
 
 @pytest.fixture(scope="session")
 def tracer_init():
-    Ecologits.init()
+    EcoLogits.init()

tests/test_tracer.py

@@ -1,8 +1,8 @@
 import pytest
-from ecologits import Ecologits
-from ecologits.exceptions import EcologitsError
+from ecologits import EcoLogits
+from ecologits.exceptions import EcoLogitsError
 
 
 def test_double_init(tracer_init):
-    with pytest.raises(EcologitsError) as e:
-        Ecologits.init()   # Second initialization
+    with pytest.raises(EcoLogitsError) as e:
+        EcoLogits.init()   # Second initialization