about summary refs log tree commit diff
path: root/pkgs/development/python-modules/json-logging/default.nix
blob: f904d6d44ac911d6bcb947061a165130b828c51e (plain) (blame)
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
{ lib
, buildPythonPackage
, fastapi
, fetchFromGitHub
, flask
, httpx
, pytestCheckHook
, pythonOlder
, pythonAtLeast
, quart
, requests
, sanic
, setuptools
, uvicorn
}:

buildPythonPackage rec {
  pname = "json-logging";
  version = "1.5.0-rc0";
  pyproject = true;

  disabled = pythonOlder "3.7";

  src = fetchFromGitHub {
    owner = "bobbui";
    repo = "json-logging-python";
    rev = "refs/tags/${version}";
    hash = "sha256-WOAEY1pONH+Gx1b8zHZDMNgJJSn7jvMO60LYTA8z/dE=";
  };

  # The logging module introduced the `taskName` field in Python 3.12, which the tests don't expect
  postPatch = lib.optionalString (pythonAtLeast "3.12") ''
    substituteInPlace tests/helpers/constants.py \
        --replace-fail '"written_at",' '"taskName", "written_at",'
  '';

  build-system = [
    setuptools
  ];

  dependencies = [
    fastapi
    flask
    httpx
    quart
    requests
    sanic
    uvicorn
  ];

  nativeCheckInputs = [
    pytestCheckHook
  ];

  pythonImportsCheck = [
    "json_logging"
  ];

  disabledTests = [
    "quart"
  ];

  disabledTestPaths = [
    # Smoke tests don't always work
    "tests/smoketests/test_run_smoketest.py"
  ];

  __darwinAllowLocalNetworking = true;

  meta = with lib; {
    description = "Python library to emit logs in JSON format";
    longDescription = ''
      Python logging library to emit JSON log that can be easily indexed and searchable by logging
      infrastructure such as ELK, EFK, AWS Cloudwatch, GCP Stackdriver.
    '';
    homepage = "https://github.com/bobbui/json-logging-python";
    changelog = "https://github.com/bobbui/json-logging-python/releases/tag/${version}";
    license = licenses.asl20;
    maintainers = with maintainers; [ AluisioASG ];
  };
}