Skip to content

Commit d940f77

Browse files
LinZhihao-723Bill-hbrhbrjunhaoliao
authored
feat(yscope-clp-core): Add yscope-clp-core to package CLP core as a Python distribution: (y-scope#1732)
* Package the `clp-s` binary as part of the wheel. * Add a task to build the wheel. * Update the workflow to build the wheel targeting `manylinux_2_28_x86_64`. Co-authored-by: Bingran Hu <bingran.hu@yscope.com> Co-authored-by: Junhao Liao <junhao@junhao.ca>
1 parent ff6f76a commit d940f77

File tree

14 files changed

+806
-0
lines changed

14 files changed

+806
-0
lines changed

.github/workflows/clp-artifact-build.yaml

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ on:
1717
env:
1818
BINARIES_ARTIFACT_NAME_PREFIX: "clp-core-binaries-"
1919
DEPS_IMAGE_NAME_PREFIX: "clp-core-dependencies-x86-"
20+
PYTHON_WHEELS_ARTIFACT_NAME_PREFIX: "clp-python-wheels-"
2021

2122
concurrency:
2223
group: "${{github.workflow}}-${{github.ref}}"
@@ -40,6 +41,7 @@ jobs:
4041
musllinux_1_2_x86_64_image_changed: "${{steps.filter.outputs.musllinux_1_2_x86_64_image}}"
4142
ubuntu_jammy_image_changed: "${{steps.filter.outputs.ubuntu_jammy_image}}"
4243
clp_changed: "${{steps.filter.outputs.clp}}"
44+
yscope_clp_core_changed: "${{steps.filter.outputs.yscope-clp-core}}"
4345
steps:
4446
- uses: "actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683"
4547
with:
@@ -97,6 +99,13 @@ jobs:
9799
- "taskfile.yaml"
98100
- "taskfiles/**"
99101
- "tools/scripts/deps-download/**"
102+
yscope-clp-core:
103+
- ".github/actions/**"
104+
- ".github/workflows/clp-artifact-build.yaml"
105+
- ".gitmodules"
106+
- "taskfile.yaml"
107+
- "taskfiles/**"
108+
- "python-wheels/yscope-clp-core/**"
100109
101110
centos-stream-9-deps-image:
102111
name: "centos-stream-9-deps-image"
@@ -281,6 +290,59 @@ jobs:
281290
--build-dir /mnt/repo/components/core/build
282291
--num-jobs $(getconf _NPROCESSORS_ONLN)
283292
293+
manylinux_2_28-x86_64-python-wheels:
294+
# Run if the ancestor jobs succeeded OR they were skipped and clp was changed.
295+
if: >-
296+
success() || (!cancelled() && !failure() && (
297+
needs.filter-relevant-changes.outputs.clp_changed == 'true'
298+
|| needs.filter-relevant-changes.outputs.yscope_clp_core_changed == 'true'
299+
))
300+
needs:
301+
- "filter-relevant-changes"
302+
- "manylinux_2_28-x86_64-deps-image"
303+
env:
304+
OS_NAME: "manylinux_2_28"
305+
name: "manylinux_2_28-x86_64-python-wheels"
306+
continue-on-error: true
307+
runs-on: *runner
308+
steps:
309+
- uses: "actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8" # v6.0.1
310+
with:
311+
submodules: "recursive"
312+
313+
- name: "Work around actions/runner-images/issues/6775"
314+
run: "chown $(id -u):$(id -g) -R ."
315+
shell: "bash"
316+
317+
- uses: "./.github/actions/run-on-image"
318+
with:
319+
image_name: "${{env.DEPS_IMAGE_NAME_PREFIX}}${{env.OS_NAME}}"
320+
use_published_image: >-
321+
${{needs.filter-relevant-changes.outputs.manylinux_2_28_x86_64_image_changed == 'false'
322+
|| (github.event_name != 'pull_request' && github.ref == 'refs/heads/main')}}
323+
run_command: >-
324+
CLP_CPP_MAX_PARALLELISM_PER_BUILD_TASK=$(getconf _NPROCESSORS_ONLN)
325+
task python-wheels-yscope-clp-core
326+
327+
- id: "copy_wheels"
328+
run: |-
329+
output_dir="/tmp/${{env.PYTHON_WHEELS_ARTIFACT_NAME_PREFIX}}${{env.OS_NAME}}"
330+
echo "output_dir=${output_dir}" >> "$GITHUB_OUTPUT"
331+
mkdir -p "${output_dir}"
332+
tar \
333+
--create \
334+
--verbose \
335+
--file "${output_dir}/python-wheels.tar" \
336+
--directory "$GITHUB_WORKSPACE/build/python-wheels" \
337+
.
338+
shell: "bash"
339+
340+
- uses: "actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f" # v6.0.0
341+
with:
342+
name: "${{env.PYTHON_WHEELS_ARTIFACT_NAME_PREFIX}}${{env.OS_NAME}}"
343+
path: "${{steps.copy_wheels.outputs.output_dir}}"
344+
retention-days: 1
345+
284346
musllinux_1_2-x86_64-binaries:
285347
# Run if the ancestor jobs succeeded OR they were skipped and clp was changed.
286348
if: >-

.github/workflows/clp-uv-checks.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ on:
1414
- "components/job-orchestration/uv.lock"
1515
- "integration-tests/pyproject.toml"
1616
- "integration-tests/uv.lock"
17+
- "python-wheels/yscope-clp-core/pyproject.toml"
18+
- "python-wheels/yscope-clp-core/uv.lock"
1719
push:
1820
paths: *monitored_paths
1921
schedule:
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
yscope_clp_core/bin
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
3.10
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# CMake configuration for scikit-build-core to package CLP core executables into the Python
2+
# distribution for use by the Python binding.
3+
4+
cmake_minimum_required(VERSION 3.31)
5+
project(${SKBUILD_PROJECT_NAME} VERSION ${SKBUILD_PROJECT_VERSION})
6+
7+
message(STATUS "yscope-clp-core version: ${SKBUILD_PROJECT_VERSION}")
8+
9+
if(DEFINED ENV{YSCOPE_CLP_CORE_CLP_S_EXE})
10+
set(CLP_S_EXE "$ENV{YSCOPE_CLP_CORE_CLP_S_EXE}")
11+
if(NOT EXISTS "${CLP_S_EXE}")
12+
message(FATAL_ERROR "clp-s executable not found at ${CLP_S_EXE}")
13+
endif()
14+
message(STATUS "Using clp-s executable from environment: ${CLP_S_EXE}")
15+
# Install the CLP core executable into the Python wheel so the Python bindings can invoke it at
16+
# runtime. Using CMake `install(PROGRAMS ...)` ensures the file:
17+
# * retains executable permissions on install,
18+
# * is copied into the package runtime tree at `yscope_clp_core/bin`,
19+
install(PROGRAMS "${CLP_S_EXE}" DESTINATION yscope_clp_core/bin)
20+
else()
21+
# Allow the build to proceed even if the CLP core executable is not found so that the linting
22+
# tools can still run without requiring the full build dependencies.
23+
message(WARNING "clp-s executable not found; skipping install.")
24+
endif()
Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# YScope CLP (Compressed Log Processor) Core Python Distribution
2+
3+
This project packages [YScope CLP core][clp-core-docs] as a Python distribution, providing the CLP
4+
core command line tools and a Python binding for performing CLP archive operations programmatically.
5+
6+
## Installation
7+
8+
To install the package:
9+
10+
```shell
11+
pip install yscope-clp-core
12+
```
13+
14+
See the PyPI project page for [release][pypi-release] details.
15+
16+
## Scope and compatibility
17+
18+
> [!IMPORTANT]
19+
> The current package only includes the `clp-s` binary. Support for additional CLP core tools will
20+
> be added in future releases.
21+
22+
## Documentation
23+
24+
For detailed usage of CLP core features and design documentation, see the official CLP documents:
25+
26+
* [**clp-s**][clp-s-docs]: CLP for JSON logs.
27+
28+
[clp-core-docs]: https://docs.yscope.com/clp/main/user-docs/index.html#core
29+
[clp-s-docs]: https://docs.yscope.com/clp/main/user-docs/core-clp-s
30+
[pypi-release]: https://pypi.org/project/yscope-clp-core

0 commit comments

Comments
 (0)