codecarbon 2.7.1__tar.gz → 2.7.2__tar.gz

{codecarbon-2.7.1 → codecarbon-2.7.2}/.gitignore

@@ -129,3 +129,7 @@ tests/test_data/rapl/*
 
 #asciinema
 *.cast
+
+
+# credentials
+credentials.json

{codecarbon-2.7.1 → codecarbon-2.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: codecarbon
-Version: 2.7.1
+Version: 2.7.2
 Project-URL: Homepage, https://codecarbon.io/
 Project-URL: Repository, https://github.com/mlco2/codecarbon
 Project-URL: Dashboard, http://dashboard.codecarbon.io/
@@ -20,6 +20,7 @@ Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.7
 Requires-Dist: arrow
 Requires-Dist: click
+Requires-Dist: fief-client[cli]
 Requires-Dist: pandas
 Requires-Dist: prometheus-client
 Requires-Dist: psutil

codecarbon-2.7.2/codecarbon/_version.py

@@ -0,0 +1 @@
+__version__ = "2.7.2"

{codecarbon-2.7.1 → codecarbon-2.7.2}/codecarbon/cli/cli_utils.py

@@ -40,12 +40,19 @@ def get_api_endpoint(path: Optional[Path] = None):
 def get_existing_local_exp_id(path: Optional[Path] = None):
     p = path or Path.cwd().resolve() / ".codecarbon.config"
     if p.exists():
-        config = configparser.ConfigParser()
-        config.read(str(p))
-        if "codecarbon" in config.sections():
-            d = dict(config["codecarbon"])
-            if "experiment_id" in d:
-                return d["experiment_id"]
+        existing_path = p
+    else:
+        existing_path = Path("~/.codecarbon.config").expanduser()
+    return _get_local_exp_id(existing_path)
+
+
+def _get_local_exp_id(p: Optional[Path] = None):
+    config = configparser.ConfigParser()
+    config.read(str(p))
+    if "codecarbon" in config.sections():
+        d = dict(config["codecarbon"])
+        if "experiment_id" in d:
+            return d["experiment_id"]
 
 
 def write_local_exp_id(exp_id, path: Optional[Path] = None):

{codecarbon-2.7.1 → codecarbon-2.7.2}/codecarbon/cli/main.py

@@ -1,9 +1,13 @@
+import os
 import time
 from pathlib import Path
 from typing import Optional
 
 import questionary
+import requests
 import typer
+from fief_client import Fief
+from fief_client.integrations.cli import FiefAuth
 from rich import print
 from rich.prompt import Confirm
 from typing_extensions import Annotated
@@ -20,10 +24,18 @@ from codecarbon.core.api_client import ApiClient, get_datetime_with_timezone
 from codecarbon.core.schemas import ExperimentCreate, OrganizationCreate, ProjectCreate
 from codecarbon.emissions_tracker import EmissionsTracker
 
+AUTH_CLIENT_ID = os.environ.get(
+    "AUTH_CLIENT_ID", "pkqh9CiOkp4MkPqRqM_k8Xc3mwBRpojS3RayIk1i5Pg"
+)
+AUTH_SERVER_URL = os.environ.get(
+    "AUTH_SERVER_URL", "https://auth.codecarbon.io/codecarbon-dev"
+)
+API_URL = os.environ.get("API_URL", "https://dash-dev.cleverapps.io/api")
+
 DEFAULT_PROJECT_ID = "e60afa92-17b7-4720-91a0-1ae91e409ba1"
 DEFAULT_ORGANIzATION_ID = "e60afa92-17b7-4720-91a0-1ae91e409ba1"
 
-codecarbon = typer.Typer()
+codecarbon = typer.Typer(no_args_is_help=True)
 
 
 def _version_callback(value: bool) -> None:
@@ -85,6 +97,52 @@ def show_config(path: Path = Path("./.codecarbon.config")) -> None:
         )
 
 
+fief = Fief(AUTH_SERVER_URL, AUTH_CLIENT_ID)
+fief_auth = FiefAuth(fief, "./credentials.json")
+print("FIEF", AUTH_SERVER_URL, AUTH_CLIENT_ID)
+
+
+def _get_access_token():
+    access_token_info = fief_auth.access_token_info()
+    access_token = access_token_info["access_token"]
+    return access_token
+
+
+@codecarbon.command(
+    "test-api", short_help="Make an authenticated GET request to an API endpoint"
+)
+def api_get():
+    """
+    ex: test-api
+    """
+    api = ApiClient(endpoint_url=API_URL)  # TODO: get endpoint from config
+    api.set_access_token(_get_access_token())
+    organizations = api.get_list_organizations()
+    print(organizations)
+
+
+@codecarbon.command("login", short_help="Login to CodeCarbon")
+def login():
+    fief_auth.authorize()
+
+
+@codecarbon.command("get-token", short_help="Get project token")
+def get_token(project_id: str):
+    # api = ApiClient(endpoint_url=API_URL) # TODO: get endpoint from config
+    # api.set_access_token(_get_access_token())
+    req = requests.post(
+        f"{API_URL}/projects/{project_id}/api-tokens",
+        json={
+            "project_id": project_id,
+            "name": "api token",
+            "x_token": "???",
+        },
+        headers={"Authorization": f"Bearer {_get_access_token()}"},
+    )
+    print("Your token: " + req.json()["token"])
+    print("Add it to the api_key field in your configuration file")
+
+
 @codecarbon.command("config", short_help="Generate or show config")
 def config():
     """
@@ -127,6 +185,7 @@ def config():
     )
     overwrite_local_config("api_endpoint", api_endpoint, path=file_path)
     api = ApiClient(endpoint_url=api_endpoint)
+    api.set_access_token(_get_access_token())
     organizations = api.get_list_organizations()
     org = questionary_prompt(
         "Pick existing organization from list or Create new organization ?",

{codecarbon-2.7.1 → codecarbon-2.7.2}/codecarbon/core/api_client.py

@@ -39,20 +39,22 @@ class ApiClient:  # (AsyncClient)
 
     def __init__(
         self,
-        endpoint_url="https://api.codecarbon.io",
+        # endpoint_url="https://api.codecarbon.io",
+        endpoint_url="https://dash-dev.cleverapps.io/api",  # beta API
         experiment_id=None,
         api_key=None,
         conf=None,
     ):
         """
         :project_id: ID of the existing project
-        :api_ley: Code Carbon API_KEY
+        :api_key: Code Carbon API_KEY
         """
         # super().__init__(base_url=endpoint_url) # (AsyncClient)
         self.url = endpoint_url
         self.experiment_id = experiment_id
         self.api_key = api_key
         self.conf = conf
+        self.access_token = None
         if self.experiment_id is not None:
             self._create_run(self.experiment_id)
         import warnings
@@ -64,12 +66,31 @@ class ApiClient:  # (AsyncClient)
             stacklevel=2,
         )
 
+    def set_access_token(self, token: str):
+        """This method sets the access token to be used for the API. For now it is not used.
+
+        Args:
+            token (str): access token to be used for the API
+        """
+        self.access_token = token
+
+    def _get_headers(self):
+        headers = {"Content-Type": "application/json"}
+        if self.api_key:
+            print(type(self.api_key))
+            # set the x-api-token header
+            headers["x-api-token"] = self.api_key
+        if self.access_token:
+            headers["Authorization"] = f"Bearer {self.access_token}"
+        return headers
+
     def get_list_organizations(self):
         """
         List all organizations
         """
         url = self.url + "/organizations"
-        r = requests.get(url=url, timeout=2)
+        headers = self._get_headers()
+        r = requests.get(url=url, timeout=2, headers=headers)
         if r.status_code != 200:
             self._log_error(url, {}, r)
             return None
@@ -99,7 +120,8 @@ class ApiClient:  # (AsyncClient)
             )
             return organization
         else:
-            r = requests.post(url=url, json=payload, timeout=2)
+            headers = self._get_headers()
+            r = requests.post(url=url, json=payload, timeout=2, headers=headers)
             if r.status_code != 201:
                 self._log_error(url, payload, r)
                 return None
@@ -109,8 +131,9 @@ class ApiClient:  # (AsyncClient)
         """
         Get an organization
         """
+        headers = self._get_headers()
         url = self.url + "/organizations/" + organization_id
-        r = requests.get(url=url, timeout=2)
+        r = requests.get(url=url, timeout=2, headers=headers)
         if r.status_code != 200:
             self._log_error(url, {}, r)
             return None
@@ -121,8 +144,9 @@ class ApiClient:  # (AsyncClient)
         Update an organization
         """
         payload = dataclasses.asdict(organization)
+        headers = self._get_headers()
         url = self.url + "/organizations/" + organization.id
-        r = requests.patch(url=url, json=payload, timeout=2)
+        r = requests.patch(url=url, json=payload, timeout=2, headers=headers)
         if r.status_code != 200:
             self._log_error(url, payload, r)
             return None
@@ -133,8 +157,8 @@ class ApiClient:  # (AsyncClient)
         List all projects
         """
         url = self.url + "/organizations/" + organization_id + "/projects"
-
-        r = requests.get(url=url, timeout=2)
+        headers = self._get_headers()
+        r = requests.get(url=url, timeout=2, headers=headers)
         if r.status_code != 200:
             self._log_error(url, {}, r)
             return None
@@ -146,7 +170,8 @@ class ApiClient:  # (AsyncClient)
         """
         payload = dataclasses.asdict(project)
         url = self.url + "/projects"
-        r = requests.post(url=url, json=payload, timeout=2)
+        headers = self._get_headers()
+        r = requests.post(url=url, json=payload, timeout=2, headers=headers)
         if r.status_code != 201:
             self._log_error(url, payload, r)
             return None
@@ -157,7 +182,8 @@ class ApiClient:  # (AsyncClient)
         Get a project
         """
         url = self.url + "/projects/" + project_id
-        r = requests.get(url=url, timeout=2)
+        headers = self._get_headers()
+        r = requests.get(url=url, timeout=2, headers=headers)
         if r.status_code != 200:
             self._log_error(url, {}, r)
             return None
@@ -199,7 +225,8 @@ class ApiClient:  # (AsyncClient)
         try:
             payload = dataclasses.asdict(emission)
             url = self.url + "/emissions"
-            r = requests.post(url=url, json=payload, timeout=2)
+            headers = self._get_headers()
+            r = requests.post(url=url, json=payload, timeout=2, headers=headers)
             if r.status_code != 201:
                 self._log_error(url, payload, r)
                 return False
@@ -239,7 +266,8 @@ class ApiClient:  # (AsyncClient)
             )
             payload = dataclasses.asdict(run)
             url = self.url + "/runs"
-            r = requests.post(url=url, json=payload, timeout=2)
+            headers = self._get_headers()
+            r = requests.post(url=url, json=payload, timeout=2, headers=headers)
             if r.status_code != 201:
                 self._log_error(url, payload, r)
                 return None
@@ -263,7 +291,8 @@ class ApiClient:  # (AsyncClient)
         List all experiments for a project
         """
         url = self.url + "/projects/" + project_id + "/experiments"
-        r = requests.get(url=url, timeout=2)
+        headers = self._get_headers()
+        r = requests.get(url=url, timeout=2, headers=headers)
         if r.status_code != 200:
             self._log_error(url, {}, r)
             return []
@@ -282,7 +311,8 @@ class ApiClient:  # (AsyncClient)
         """
         payload = dataclasses.asdict(experiment)
         url = self.url + "/experiments"
-        r = requests.post(url=url, json=payload, timeout=2)
+        headers = self._get_headers()
+        r = requests.post(url=url, json=payload, timeout=2, headers=headers)
         if r.status_code != 201:
             self._log_error(url, payload, r)
             return None
@@ -293,7 +323,8 @@ class ApiClient:  # (AsyncClient)
         Get an experiment by id
         """
         url = self.url + "/experiments/" + experiment_id
-        r = requests.get(url=url, timeout=2)
+        headers = self._get_headers()
+        r = requests.get(url=url, timeout=2, headers=headers)
         if r.status_code != 200:
             self._log_error(url, {}, r)
             return None

{codecarbon-2.7.1 → codecarbon-2.7.2}/codecarbon/core/gpu.py

@@ -124,8 +124,11 @@ class GPUDevice:
         """Returns the name of the GPU device
         https://docs.nvidia.com/deploy/nvml-api/group__nvmlDeviceQueries.html#group__nvmlDeviceQueries_1ga5361803e044c6fdf3b08523fb6d1481
         """
-        name = pynvml.nvmlDeviceGetName(self.handle)
-        return self._to_utf8(name)
+        try:
+            name = pynvml.nvmlDeviceGetName(self.handle)
+            return self._to_utf8(name)
+        except UnicodeDecodeError:
+            return "Unknown GPU"
 
     def _get_uuid(self) -> Any:
         """Returns the globally unique GPU device UUID

{codecarbon-2.7.1 → codecarbon-2.7.2}/codecarbon/emissions_tracker.py

@@ -256,6 +256,7 @@ class BaseEmissionsTracker(ABC):
 
         self._set_from_conf(api_call_interval, "api_call_interval", 8, int)
         self._set_from_conf(api_endpoint, "api_endpoint", "https://api.codecarbon.io")
+        self._set_from_conf(api_key, "api_key", "api_key")
         self._set_from_conf(co2_signal_api_token, "co2_signal_api_token")
         self._set_from_conf(emissions_endpoint, "emissions_endpoint")
         self._set_from_conf(experiment_name, "experiment_name", "base")
@@ -345,7 +346,7 @@ class BaseEmissionsTracker(ABC):
         self._emissions: Emissions = Emissions(
             self._data_source, self._co2_signal_api_token
         )
-        self._init_output_methods(api_key)
+        self._init_output_methods(self._api_key)
 
     def set_CPU_GPU_ram_tracking(self):
         cpu_tracker = gpu_tracker = ram_tracker = "Unspecified"

{codecarbon-2.7.1 → codecarbon-2.7.2}/pyproject.toml

@@ -27,6 +27,7 @@ classifiers = [
 dependencies = [
     "arrow",
     "click",
+    "fief-client[cli]",
     "pandas",
     "prometheus_client",
     "psutil",
@@ -150,7 +151,7 @@ dependencies = [
     "requests<3.0.0",
     "sqlalchemy<2.0.0",
     "uvicorn[standard]<1.0.0",
-    "fastapi-pagination<1.0.0",
+    "fastapi-pagination==0.9.1",
     "pytest",
     "mock",
     "pytest",
@@ -181,7 +182,7 @@ include = [
 ]
 
 [tool.bumpver]
-current_version = "2.7.1"
+current_version = "2.7.2"
 version_pattern = "MAJOR.MINOR.PATCH"
 
 [tool.bumpver.file_patterns]

codecarbon-2.7.1/codecarbon/_version.py

@@ -1 +0,0 @@
-__version__ = "2.7.1"