qcs-api-client-common 0.13.1-dev.4

Common code for QCS API clients
Documentation 
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

[tasks.check-venv]
description = "Check if a virtual environment is activated"
script = [
    '''
    if [ -z "$VIRTUAL_ENV" ]; then
        echo "No virtual environment activated. Please activate one."
        exit 1
    else
        echo "Virtual environment is active."
    fi
    '''
]

[tasks.install-uv]
dependencies = ["check-venv"]
description = "Install dependencies using uv"
command = "pip"
args = ["install", "uv"]

[tasks.install-deps]
dependencies = ["install-uv"]
description = "Install dependencies using uv"
command = "uv"
args = ["pip", "install", ".[dev]"]

[tasks.install-python-package]
dependencies = ["install-deps"]
description = "Build the qcs-api-client-common python package and install it in the current virtual environment."
command = "maturin"
args = ["develop"]

[tasks.stubtest]
dependencies = ["install-python-package"]
description = "Validate type stubs using stubtest"
command = "stubtest"
args = ["--allowlist", ".stubtest-allowlist", "qcs_api_client_common"]

[tasks.stubtest-watch]
dependencies = ["install-python-package"]
description = "Validate type stubs using stubtest in watch mode, re-validating when the stubs are updated."
command = "watchmedo"
args = [
  "shell-command",
  "--command",
  "sh ./scripts/watchmedo_helper.sh ${watch_src_path} 'stubtest qcs_api_client_common --allowlist .stubtest-allowlist'",
  "--pattern",
  "*.py;*.pyi;*.rs;.stubtest-allowlist", 
  "--recursive",
  ".",
]

[tasks.pytest]
dependencies = ["install-python-package"]
description = "Run the Python unit test suite."
command = "pytest"
args = ["tests_py", "-vv"]

[tasks.pytest-watch]
dependencies = ["install-python-package"]
command = "pytest"
args = [
  "watchmedo",
  "shell-command",
  "--command",
  "sh ./scripts/watchmedo_helper.sh ${watch_src_path} 'cargo make pytest'",
  "--pattern",
  "*.py;*.pyi;*.rs", 
  "--recursive",
  "./",
]

[tasks.pytest-integration]
dependencies = ["install-python-package"]
description = "Run the integration tests in the Python test suite. Requires a valid QCS configuration."
command = "poetry"
args = ["run", "pytest", "tests_py", "--integration"]

[tasks.build-python-docs]
dependencies = ["install-python-package"]
description = "Build the Sphinx documentation."
cwd = "docs"
script = [
    '''
    make html
    '''
]

[tasks.ruff-check]
dependencies = ["install-uv"]
command = "ruff"
args = ["check"]

[tasks.dev-flow]
dependencies = ["dev-test-flow", "pytest", "stubtest", "ruff-check"]

[tasks.default]
alias = "dev-flow"