summaryrefslogtreecommitdiff
path: root/pkgs/development/python-modules/codecarbon/default.nix
blob: 18357da80608c80f7aa6fbad6309b2947d4fbf72 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
{
  lib,
  buildPythonPackage,
  fetchFromGitHub,

  # build-system
  setuptools,

  # dependencies
  arrow,
  authlib,
  click,
  nvidia-ml-py,
  pandas,
  prometheus-client,
  psutil,
  py-cpuinfo,
  pycountry,
  pydantic,
  questionary,
  rapidfuzz,
  requests,
  rich,
  typer,

  # optional-dependencies
  amdsmi,
  dash,
  dash-bootstrap-components,
  fire,

  # tests
  bcrypt,
  dependency-injector,
  email-validator,
  fastapi,
  fastapi-pagination,
  httpx,
  jwt,
  logfire,
  psycopg2,
  pydantic-settings,
  pytestCheckHook,
  requests-mock,
  responses,
  sqlalchemy,
}:

buildPythonPackage (finalAttrs: {
  pname = "codecarbon";
  version = "3.2.7";
  pyproject = true;
  __structuredAttrs = true;

  src = fetchFromGitHub {
    owner = "mlco2";
    repo = "codecarbon";
    tag = "v${finalAttrs.version}";
    hash = "sha256-9eec43jszRCiA6oD3T8YTXXRkrq0ESLhSwmxL4Pg9fc=";
  };

  build-system = [
    setuptools
  ];

  dependencies = [
    arrow
    authlib
    click
    nvidia-ml-py
    pandas
    prometheus-client
    psutil
    py-cpuinfo
    pycountry
    pydantic
    questionary
    rapidfuzz
    requests
    rich
    typer
  ];

  optional-dependencies = {
    amdsmi = [
      amdsmi
    ];
    carbonboard = [
      dash
      dash-bootstrap-components
      fire
    ];
    viz-legacy = [
      dash
      dash-bootstrap-components
      fire
    ];
  };

  pythonImportsCheck = [ "codecarbon" ];

  nativeBuildInputs = [
    bcrypt
    dash
    dependency-injector
    email-validator
    fastapi
    fastapi-pagination
    httpx
    jwt
    logfire
    psycopg2
    pydantic-settings
    pytestCheckHook
    requests-mock
    responses
    sqlalchemy
  ];

  enabledTestPaths = [
    "carbonserver/tests/"
  ];

  disabledTestPaths = [
    # Fail in the sandbox:
    # FileNotFoundError: [Errno 2] No such file or directory: '/sys/class/powercap/intel-rapl/intel-rapl:0/energy_uj'
    "examples/"

    # _pytest.outcomes.Exit: CODECARBON_API_URL is not defined
    "carbonserver/tests/api/integration/test_api_black_box.py"

    # Require unpackaged (and unmaintained) fief-client
    "carbonserver/tests/api/routers/"
    "carbonserver/tests/api/service/test_auth_provider.py"

    # Require internet access
    "carbonserver/tests/api/integration/test_project_cascade_delete.py"
  ];

  disabledTests = [
    # AttributeError: <module 'jwt' from ...> does not have the attribute 'decode'
    "test_check_user_from_jwt"
  ];

  meta = {
    description = "Track emissions from Compute and recommend ways to reduce their impact on the environment";
    homepage = "https://github.com/mlco2/codecarbon";
    changelog = "https://github.com/mlco2/codecarbon/releases/tag/${finalAttrs.src.tag}";
    license = lib.licenses.mit;
    maintainers = with lib.maintainers; [ GaetanLepage ];
  };
})