Skip to content

Commit ba82a90

Browse files
authored
Merge pull request #1 from Sightengine/demo
Demo
2 parents d9ba56c + af8a1a8 commit ba82a90

24 files changed

+3403
-273
lines changed

.github/workflows/cross_platform_tests.yml

Lines changed: 55 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ name: Cross-Platform Tests
33
on:
44
push:
55
branches: [ main, master ]
6-
pull_request:
7-
branches: [ main, master ]
6+
tags:
7+
- 'v*.*.*' # Only trigger on tags like v1.0.0, v1.2.3
88
workflow_dispatch: # Allows manual triggering
99

1010
# Add this section to control notification behavior
@@ -25,8 +25,8 @@ jobs:
2525
strategy:
2626
fail-fast: false # Continue with other jobs if one fails
2727
matrix:
28-
os: [ubuntu-latest, macos-latest]
29-
python-version: ['3.11']
28+
os: [ubuntu-22.04]
29+
python-version: ['3.11', '3.12']
3030

3131
steps:
3232
- uses: actions/checkout@v4
@@ -66,6 +66,12 @@ jobs:
6666
echo "VIRTUAL_ENV=$PWD/.venv" >> $GITHUB_ENV
6767
echo "$PWD/.venv/bin" >> $GITHUB_PATH
6868
69+
- name: Install system dependencies
70+
run: |
71+
sudo apt-get update
72+
sudo apt-get install -y libssl-dev pkg-config build-essential
73+
shell: bash
74+
6975
- name: Install dependencies
7076
run: |
7177
python -m pip install --upgrade pip
@@ -76,24 +82,24 @@ jobs:
7682
- name: Build and install package with maturin
7783
uses: PyO3/maturin-action@v1
7884
with:
79-
python-interpreter: ${{ steps.setup_python.outputs.python-path }}
80-
target: ${{ matrix.os == 'macos-latest' && 'universal2-apple-darwin' || 'x86_64' }}
85+
target: x86_64
8186
command: develop
8287
args: --release
8388
sccache: 'true'
8489

85-
- name: Run tests
86-
run: python run_tests.py
90+
- name: Run API tests only
91+
run: python run_tests.py --api-only
8792
continue-on-error: true # Continue even if tests fail to get wheels
8893

8994
- name: Build wheel
9095
uses: PyO3/maturin-action@v1
9196
with:
92-
python-interpreter: ${{ steps.setup_python.outputs.python-path }}
93-
target: ${{ matrix.os == 'macos-latest' && 'universal2-apple-darwin' || 'x86_64' }}
97+
target: x86_64
9498
command: build
9599
args: --release
96100
sccache: 'true'
101+
env:
102+
OPENSSL_NO_VENDOR: 1
97103

98104
- name: Upload wheels
99105
uses: actions/upload-artifact@v4
@@ -117,8 +123,46 @@ jobs:
117123
run: find wheels -type f -name "*.whl" | sort
118124
shell: bash
119125

126+
- name: Flatten wheel structure
127+
run: |
128+
mkdir -p dist
129+
find wheels -name "*.whl" -exec cp {} dist/ \;
130+
echo "Files in dist after flattening:"
131+
ls -la dist/
132+
120133
- name: Upload combined wheels
121134
uses: actions/upload-artifact@v4
122135
with:
123136
name: all-wheels
124-
path: wheels/*/*.whl
137+
path: dist/*.whl
138+
139+
publish_to_pypi:
140+
name: Publish Python distributions to PyPI
141+
needs: collect_wheels
142+
runs-on: ubuntu-latest
143+
environment: pypi
144+
# Trigger on tags (releases) OR manual workflow dispatch
145+
if: startsWith(github.ref, 'refs/tags/v') || github.event_name == 'workflow_dispatch'
146+
permissions:
147+
id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
148+
149+
steps:
150+
- name: Download all wheels
151+
uses: actions/download-artifact@v4
152+
with:
153+
name: all-wheels
154+
path: dist/
155+
156+
- name: List downloaded files
157+
run: |
158+
echo "Files in dist/:"
159+
ls -la dist/
160+
echo "Checking for .whl files specifically:"
161+
find dist -name "*.whl" -type f
162+
echo "Wheel file details:"
163+
find dist -name "*.whl" -type f -exec basename {} \;
164+
165+
- name: Publish to PyPI
166+
uses: pypa/gh-action-pypi-publish@release/v1
167+
168+

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,7 @@ wheels/
4040
.env
4141
.venv
4242
venv/
43-
ENV/
43+
ENV/
44+
45+
# Cursor rules
46+
.cursorrules

Cargo.toml

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,22 @@
11
[package]
2-
name = "fast_c2pa_reader"
2+
name = "fast-c2pa-python"
33
version = "0.1.0"
44
edition = "2021"
5+
authors = ["Sightengine <info@sightengine.com>"]
6+
license = "MIT OR Apache-2.0"
7+
description = "Fast Python library for reading C2PA metadata using PyO3 bindings to c2pa-rs"
8+
keywords = ["c2pa", "metadata", "python", "bindings"]
59

610
[lib]
7-
name = "fast_c2pa_reader"
11+
name = "fast_c2pa_core"
812
crate-type = ["cdylib"]
913

1014
[dependencies]
1115
c2pa = { version = "0.49.5", features = ["file_io"] }
1216
pyo3 = { version = "0.19.0", features = ["extension-module"] }
1317
serde_json = "1.0"
18+
log = "0.4"
19+
image = "0.25.6"
1420

1521
# Optimize for performance in release builds
1622
[profile.release]
@@ -19,4 +25,4 @@ lto = "fat" # Link-time optimization
1925
codegen-units = 1 # Slower build, better optimization
2026
panic = "abort" # Remove unwinding code
2127
strip = true # Strip symbols from binary
22-
debug = false # No debug info
28+
debug = false # No debug info

LICENSE

Lines changed: 196 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,196 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Sightengine
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.
22+
23+
================================================================================
24+
25+
This project incorporates the c2pa-rs library (https://github.com/contentauth/c2pa-rs)
26+
Copyright (c) Content Authenticity Initiative contributors
27+
which is dual-licensed under MIT and Apache 2.0 licenses.
28+
29+
Apache License
30+
Version 2.0, January 2004
31+
http://www.apache.org/licenses/
32+
33+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
34+
35+
1. Definitions.
36+
37+
"License" shall mean the terms and conditions for use, reproduction,
38+
and distribution as defined by Sections 1 through 9 of this document.
39+
40+
"Licensor" shall mean the copyright owner or entity granting the License.
41+
42+
"Legal Entity" shall mean the union of the acting entity and all
43+
other entities that control, are controlled by, or are under common
44+
control with that entity. For the purposes of this definition,
45+
"control" means (i) the power, direct or indirect, to cause the
46+
direction or management of such entity, whether by contract or
47+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
48+
outstanding shares, or (iii) beneficial ownership of such entity.
49+
50+
"You" (or "Your") shall mean an individual or Legal Entity
51+
exercising permissions granted by this License.
52+
53+
"Source" form shall mean the preferred form for making modifications,
54+
including but not limited to software source code, documentation
55+
source, and configuration files.
56+
57+
"Object" form shall mean any form resulting from mechanical
58+
transformation or translation of a Source form, including but
59+
not limited to compiled object code, generated documentation,
60+
and conversions to other media types.
61+
62+
"Work" shall mean the work of authorship, whether in Source or
63+
Object form, made available under the License, as indicated by a
64+
copyright notice that is included in or attached to the work
65+
(which may include materials held in the "License Appendix").
66+
67+
"Derivative Works" shall mean any work, whether in Source or Object
68+
form, that is based upon (or derived from) the Work and for which the
69+
editorial revisions, annotations, elaborations, or other modifications
70+
represent, as a whole, an original work of authorship. For the purposes
71+
of this License, Derivative Works shall not include works that remain
72+
separable from, or merely link (or bind by name) to the interfaces of,
73+
the Work and derivative works thereof.
74+
75+
"Contribution" shall mean any work of authorship, including
76+
the original version of the Work and any modifications or additions
77+
to that Work or Derivative Works thereof, that is intentionally
78+
submitted to Licensor for inclusion in the Work by the copyright owner
79+
or by an individual or Legal Entity authorized to submit on behalf of
80+
the copyright owner. For the purposes of this definition, "submitted"
81+
means any form of electronic, verbal, or written communication sent
82+
to the Licensor or its representatives, including but not limited to
83+
communication on electronic mailing lists, source code control
84+
systems, and issue tracking systems that are managed by, or on behalf
85+
of, the Licensor for the purpose of discussing and improving the Work,
86+
but excluding communication that is conspicuously marked or otherwise
87+
designated in writing by the copyright owner as "Not a Contribution."
88+
89+
"Contributor" shall mean Licensor and any individual or Legal Entity
90+
on behalf of whom a Contribution has been received by Licensor and
91+
subsequently incorporated within the Work.
92+
93+
2. Grant of Copyright License. Subject to the terms and conditions of
94+
this License, each Contributor hereby grants to You a perpetual,
95+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
96+
copyright license to use, reproduce, modify, display, perform,
97+
sublicense, and distribute the Work and such Derivative Works in
98+
Source or Object form.
99+
100+
3. Grant of Patent License. Subject to the terms and conditions of
101+
this License, each Contributor hereby grants to You a perpetual,
102+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
103+
(except as stated in this section) patent license to make, have made,
104+
use, offer to sell, sell, import, and otherwise transfer the Work,
105+
where such license applies only to those patent claims licensable
106+
by such Contributor that are necessarily infringed by their
107+
Contribution(s) alone or by combination of their Contribution(s)
108+
with the Work to which such Contribution(s) was submitted. If You
109+
institute patent litigation against any entity (including a
110+
cross-claim or counterclaim in a lawsuit) alleging that the Work
111+
or a Contribution incorporated within the Work constitutes direct
112+
or contributory patent infringement, then any patent licenses
113+
granted to You under this License for that Work shall terminate
114+
as of the date such litigation is filed.
115+
116+
4. Redistribution. You may reproduce and distribute copies of the
117+
Work or Derivative Works thereof in any medium, with or without
118+
modifications, and in Source or Object form, provided that You
119+
meet the following conditions:
120+
121+
(a) You must give any other recipients of the Work or
122+
Derivative Works a copy of this License; and
123+
124+
(b) You must cause any modified files to carry prominent notices
125+
stating that You changed the files; and
126+
127+
(c) You must retain, in the Source form of any Derivative Works
128+
that You distribute, all copyright, trademark, patent,
129+
attribution and other notices from the Source form of the Work,
130+
excluding those notices that do not pertain to any part of
131+
the Derivative Works; and
132+
133+
(d) If the Work includes a "NOTICE" file as part of its
134+
distribution, then any Derivative Works that You distribute must
135+
include a readable copy of the attribution notices contained
136+
within such NOTICE file, excluding those notices that do not
137+
pertain to any part of the Derivative Works, in at least one
138+
of the following places: within a NOTICE file distributed
139+
as part of the Derivative Works; within the Source form or
140+
documentation, if provided along with the Derivative Works; or,
141+
within a display generated by the Derivative Works, if and
142+
wherever such third-party notices normally appear. The contents
143+
of the NOTICE file are for informational purposes only and
144+
do not modify the License. You may add Your own attribution
145+
notices within Derivative Works that You distribute, alongside
146+
or as an addendum to the NOTICE text from the Work, provided
147+
that such additional attribution notices cannot be construed
148+
as modifying the License.
149+
150+
You may add Your own copyright notice regarding Your contributions.
151+
152+
5. Submission of Contributions. Unless You explicitly state otherwise,
153+
any Contribution intentionally submitted for inclusion in the Work
154+
by You to the Licensor shall be under the terms and conditions of
155+
this License, without any additional terms or conditions.
156+
Notwithstanding the above, nothing herein shall supersede or modify
157+
the terms of any separate license agreement you may have executed
158+
with Licensor regarding such Contributions.
159+
160+
6. Trademarks. This License does not grant permission to use the trade
161+
names, trademarks, service marks, or product names of the Licensor,
162+
except as required for reasonable and customary use in describing the
163+
origin of the Work and reproducing the content of the NOTICE file.
164+
165+
7. Disclaimer of Warranty. Unless required by applicable law or
166+
agreed to in writing, Licensor provides the Work (and each
167+
Contributor provides its Contributions) on an "AS IS" BASIS,
168+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
169+
implied, including, without limitation, any warranties or conditions
170+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
171+
PARTICULAR PURPOSE. You are solely responsible for determining the
172+
appropriateness of using or redistributing the Work and assume any
173+
risks associated with Your exercise of permissions under this License.
174+
175+
8. Limitation of Liability. In no event and under no legal theory,
176+
whether in tort (including negligence), contract, or otherwise,
177+
unless required by applicable law (such as deliberate and grossly
178+
negligent acts) or agreed to in writing, shall any Contributor be
179+
liable to You for damages, including any direct, indirect, special,
180+
incidental, or consequential damages of any character arising as a
181+
result of this License or out of the use or inability to use the
182+
Work (including but not limited to damages for loss of goodwill,
183+
work stoppage, computer failure or malfunction, or any and all
184+
other commercial damages or losses), even if such Contributor
185+
has been advised of the possibility of such damages.
186+
187+
9. Accepting Warranty or Support. You may choose to offer, and charge a
188+
fee for, warranty, support, indemnity or other liability obligations
189+
and/or rights consistent with this License. However, in accepting such
190+
obligations, You may act only on Your own behalf and on Your sole
191+
responsibility, not on behalf of any other Contributor, and only if
192+
You agree to indemnify, defend, and hold each Contributor harmless for
193+
any liability incurred by, or claims asserted against, such Contributor
194+
by reason of your accepting any such warranty or support.
195+
196+
END OF TERMS AND CONDITIONS

Makefile

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
dev:
2+
maturin develop
3+
4+
dev-release:
5+
maturin develop --release
6+
7+
test: dev
8+
python -m pytest tests/ -v
9+
10+
test-perf: dev-release
11+
python -m pytest tests/test_performance.py -s -v
12+
13+
test-api: dev
14+
python -m pytest tests/test_api.py -s -v
15+
16+
clean:
17+
cargo clean
18+
rm -rf target/

0 commit comments

Comments
 (0)