c2pa-python 0.8.3__tar.gz → 0.10.0__tar.gz

c2pa_python-0.10.0/MANIFEST.in

@@ -0,0 +1,6 @@
+include LICENSE-MIT
+include LICENSE-APACHE
+include README.md
+include requirements.txt
+include scripts/download_artifacts.py
+recursive-include src/c2pa *.py

c2pa_python-0.10.0/PKG-INFO

@@ -0,0 +1,156 @@
+Metadata-Version: 2.4
+Name: c2pa-python
+Version: 0.10.0
+Summary: Python bindings for the C2PA Content Authenticity Initiative (CAI) library
+Author-email: Gavin Peacock <gvnpeacock@adobe.com>, Tania Mathern <mathern@adobe.com>
+Maintainer-email: Gavin Peacock <gpeacock@adobe.com>
+License: MIT OR Apache-2.0
+Project-URL: homepage, https://contentauthenticity.org
+Project-URL: repository, https://github.com/contentauth/c2pa-python
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: Microsoft :: Windows
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: wheel>=0.41.2
+Requires-Dist: setuptools>=68.0.0
+Requires-Dist: toml>=0.10.2
+Requires-Dist: pytest>=7.4.0
+Requires-Dist: cryptography>=41.0.0
+Requires-Dist: requests>=2.0.0
+Dynamic: requires-python
+
+# Python API for C2PA
+
+This project provides a Python API for working with [C2PA](https://c2pa.org/) (Coalition for Content Provenance and Authenticity) manifests. It includes functionality for creating, signing, and verifying C2PA manifests, as well as working with assets and assertions.
+
+## Features
+
+- Create and sign C2PA manifests using various signing algorithms.
+- Verify C2PA manifests and extract metadata.
+- Add assertions and ingredients to assets.
+- Examples and unit tests to demonstrate usage.
+
+## Project Structure
+
+```bash
+.
+├── .github/                  # GitHub configuration files
+├── artifacts/                # Platform-specific libraries for building (per subfolder)
+│   └── your_target_platform/ # Platform-specific artifacts
+├── docs/                     # Project documentation
+├── examples/                 # Example scripts demonstrating usage
+├── scripts/                  # Utility scripts (eg. artifacts download)
+├── src/                      # Source code
+│   └── c2pa/                 # Main package directory
+│       └── libs/             # Platform-specific libraries
+├── tests/                    # Unit tests and benchmarks
+├── .gitignore                # Git ignore rules
+├── Makefile                  # Build and development commands
+├── pyproject.toml            # Python project configuration
+├── requirements.txt          # Python dependencies
+├── requirements-dev.txt      # Development dependencies
+└── setup.py                  # Package setup script
+```
+
+## Package installation
+
+The c2pa-python package is published to PyPI. You can install it from there by running:
+
+```bash
+pip install c2pa-python
+```
+
+To use the module in your Python code, import like this:
+
+```python
+import c2pa
+```
+
+## Examples
+
+### Adding a "Do Not Train" Assertion
+
+The `examples/training.py` script demonstrates how to add a "Do Not Train" assertion to an asset and verify it.
+
+### Signing and Verifying Assets
+
+The `examples/sign.py` script shows how to sign an asset with a C2PA manifest and verify it.
+
+## Development Setup
+
+1. Create and activate a virtual environment with native dependencies:
+
+```bash
+# Create virtual environment
+python -m venv .venv
+
+# Activate virtual environment
+# On Windows:
+.venv\Scripts\activate
+# On macOS/Linux:
+source .venv/bin/activate
+
+# load project dependencies
+pip install -r requirements.txt
+pip install -r requirements-dev.txt
+
+# download library artifacts for the current version you want, eg v0.55.0
+python scripts/download_artifacts.py c2pa-v0.55.0
+```
+
+2. Install the package in development mode:
+
+```bash
+pip install -e .
+```
+
+This will:
+
+- Copy the appropriate libraries for your platform from `artifacts/` to `src/c2pa/libs/`
+- Install the package in development mode, allowing you to make changes to the Python code without reinstalling
+
+## Building Wheels
+
+To build wheels for all platforms that have libraries in the `artifacts/` directory:
+
+```bash
+python setup.py bdist_wheel
+```
+
+You can use `twine` to verify the wheels have correct metadata:
+
+```bash
+twine check dist/*
+```
+
+This will create platform-specific wheels in the `dist/` directory.
+
+## Running Tests
+
+Run the tests:
+
+```bash
+make test
+```
+
+Alternatively, install pytest (if not already installed):
+
+```bash
+pip install pytest
+```
+
+And run:
+
+```bash
+pytest
+```
+
+## Contributing
+
+Contributions are welcome! Please fork the repository and submit a pull request.
+
+## License
+
+This project is licensed under the Apache License 2.0 or the MIT License. See the LICENSE-MIT and LICENSE-APACHE files for details.

c2pa_python-0.10.0/README.md

@@ -0,0 +1,133 @@
+# Python API for C2PA
+
+This project provides a Python API for working with [C2PA](https://c2pa.org/) (Coalition for Content Provenance and Authenticity) manifests. It includes functionality for creating, signing, and verifying C2PA manifests, as well as working with assets and assertions.
+
+## Features
+
+- Create and sign C2PA manifests using various signing algorithms.
+- Verify C2PA manifests and extract metadata.
+- Add assertions and ingredients to assets.
+- Examples and unit tests to demonstrate usage.
+
+## Project Structure
+
+```bash
+.
+├── .github/                  # GitHub configuration files
+├── artifacts/                # Platform-specific libraries for building (per subfolder)
+│   └── your_target_platform/ # Platform-specific artifacts
+├── docs/                     # Project documentation
+├── examples/                 # Example scripts demonstrating usage
+├── scripts/                  # Utility scripts (eg. artifacts download)
+├── src/                      # Source code
+│   └── c2pa/                 # Main package directory
+│       └── libs/             # Platform-specific libraries
+├── tests/                    # Unit tests and benchmarks
+├── .gitignore                # Git ignore rules
+├── Makefile                  # Build and development commands
+├── pyproject.toml            # Python project configuration
+├── requirements.txt          # Python dependencies
+├── requirements-dev.txt      # Development dependencies
+└── setup.py                  # Package setup script
+```
+
+## Package installation
+
+The c2pa-python package is published to PyPI. You can install it from there by running:
+
+```bash
+pip install c2pa-python
+```
+
+To use the module in your Python code, import like this:
+
+```python
+import c2pa
+```
+
+## Examples
+
+### Adding a "Do Not Train" Assertion
+
+The `examples/training.py` script demonstrates how to add a "Do Not Train" assertion to an asset and verify it.
+
+### Signing and Verifying Assets
+
+The `examples/sign.py` script shows how to sign an asset with a C2PA manifest and verify it.
+
+## Development Setup
+
+1. Create and activate a virtual environment with native dependencies:
+
+```bash
+# Create virtual environment
+python -m venv .venv
+
+# Activate virtual environment
+# On Windows:
+.venv\Scripts\activate
+# On macOS/Linux:
+source .venv/bin/activate
+
+# load project dependencies
+pip install -r requirements.txt
+pip install -r requirements-dev.txt
+
+# download library artifacts for the current version you want, eg v0.55.0
+python scripts/download_artifacts.py c2pa-v0.55.0
+```
+
+2. Install the package in development mode:
+
+```bash
+pip install -e .
+```
+
+This will:
+
+- Copy the appropriate libraries for your platform from `artifacts/` to `src/c2pa/libs/`
+- Install the package in development mode, allowing you to make changes to the Python code without reinstalling
+
+## Building Wheels
+
+To build wheels for all platforms that have libraries in the `artifacts/` directory:
+
+```bash
+python setup.py bdist_wheel
+```
+
+You can use `twine` to verify the wheels have correct metadata:
+
+```bash
+twine check dist/*
+```
+
+This will create platform-specific wheels in the `dist/` directory.
+
+## Running Tests
+
+Run the tests:
+
+```bash
+make test
+```
+
+Alternatively, install pytest (if not already installed):
+
+```bash
+pip install pytest
+```
+
+And run:
+
+```bash
+pytest
+```
+
+## Contributing
+
+Contributions are welcome! Please fork the repository and submit a pull request.
+
+## License
+
+This project is licensed under the Apache License 2.0 or the MIT License. See the LICENSE-MIT and LICENSE-APACHE files for details.

c2pa_python-0.10.0/pyproject.toml

@@ -0,0 +1,37 @@
+[build-system]
+requires = ["setuptools>=68.0.0", "wheel", "toml>=0.10.2"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "c2pa-python"
+version = "0.10.0"
+requires-python = ">=3.10"
+description = "Python bindings for the C2PA Content Authenticity Initiative (CAI) library"
+readme = { file = "README.md", content-type = "text/markdown" }
+license = { text = "MIT OR Apache-2.0" }
+authors = [{ name = "Gavin Peacock", email = "gvnpeacock@adobe.com" }, { name = "Tania Mathern", email = "mathern@adobe.com" }]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: MacOS",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: Microsoft :: Windows"
+]
+maintainers = [
+  {name = "Gavin Peacock", email = "gpeacock@adobe.com"}
+]
+urls = {homepage = "https://contentauthenticity.org", repository = "https://github.com/contentauth/c2pa-python"}
+dependencies = [
+    "wheel>=0.41.2",
+    "setuptools>=68.0.0",
+    "toml>=0.10.2",
+    "pytest>=7.4.0",
+    "cryptography>=41.0.0",
+    "requests>=2.0.0"
+]
+
+[project.scripts]
+download-artifacts = "c2pa.build:download_artifacts"
+
+# Workaround to prevent setuptools from automatically including invalid metadata
+[tool.setuptools]
+license-files = []

c2pa_python-0.10.0/requirements.txt

@@ -0,0 +1,2 @@
+# only used in the training example
+cryptography>=45.0.3

c2pa_python-0.10.0/scripts/download_artifacts.py

@@ -0,0 +1,159 @@
+#!/usr/bin/env python3
+import os
+import sys
+import requests
+from pathlib import Path
+import zipfile
+import io
+import shutil
+import platform
+import subprocess
+
+# Constants
+REPO_OWNER = "contentauth"
+REPO_NAME = "c2pa-rs"
+GITHUB_API_BASE = "https://api.github.com"
+SCRIPTS_ARTIFACTS_DIR = Path("scripts/artifacts")
+ROOT_ARTIFACTS_DIR = Path("artifacts")
+
+def detect_os():
+    """Detect the operating system and return the corresponding platform identifier."""
+    system = platform.system().lower()
+    if system == "darwin":
+        return "apple-darwin"
+    elif system == "linux":
+        return "unknown-linux-gnu"
+    elif system == "windows":
+        return "pc-windows-msvc"
+    else:
+        raise ValueError(f"Unsupported operating system: {system}")
+
+def detect_arch():
+    """Detect the CPU architecture and return the corresponding identifier."""
+    machine = platform.machine().lower()
+
+    # Handle common architecture names
+    if machine in ["x86_64", "amd64"]:
+        return "x86_64"
+    elif machine in ["arm64", "aarch64"]:
+        return "aarch64"
+    else:
+        raise ValueError(f"Unsupported CPU architecture: {machine}")
+
+def get_platform_identifier():
+    """Get the full platform identifier (arch-os) for the current system,
+    matching the identifiers used by the Github publisher.
+    Returns one of:
+    - universal-apple-darwin (for Mac)
+    - x86_64-pc-windows-msvc (for Windows 64-bit)
+    - x86_64-unknown-linux-gnu (for Linux 64-bit)
+    """
+    system = platform.system().lower()
+
+    if system == "darwin":
+        return "universal-apple-darwin"
+    elif system == "windows":
+        return "x86_64-pc-windows-msvc"
+    elif system == "linux":
+        return "x86_64-unknown-linux-gnu"
+    else:
+        raise ValueError(f"Unsupported operating system: {system}")
+
+def get_release_by_tag(tag):
+    """Get release information for a specific tag from GitHub."""
+    url = f"{GITHUB_API_BASE}/repos/{REPO_OWNER}/{REPO_NAME}/releases/tags/{tag}"
+    print(f"Fetching release information from {url}...")
+    headers = {}
+    if 'GITHUB_TOKEN' in os.environ:
+        headers['Authorization'] = f"token {os.environ['GITHUB_TOKEN']}"
+    response = requests.get(url, headers=headers)
+    response.raise_for_status()
+    return response.json()
+
+def download_and_extract_libs(url, platform_name):
+    """Download a zip artifact and extract only the libs folder."""
+    print(f"Downloading artifact for {platform_name}...")
+    platform_dir = SCRIPTS_ARTIFACTS_DIR / platform_name
+    platform_dir.mkdir(parents=True, exist_ok=True)
+
+    headers = {}
+    if 'GITHUB_TOKEN' in os.environ:
+        headers['Authorization'] = f"token {os.environ['GITHUB_TOKEN']}"
+    response = requests.get(url, headers=headers)
+    response.raise_for_status()
+
+    with zipfile.ZipFile(io.BytesIO(response.content)) as zip_ref:
+        # Extract only files inside the libs/ directory
+        for member in zip_ref.namelist():
+            print(f"  Processing zip member: {member}")
+            if member.startswith("lib/") and not member.endswith("/"):
+                print(f"    Processing lib file from downloadedzip: {member}")
+                target_path = platform_dir / os.path.relpath(member, "lib")
+                print(f"      Moving file to target path: {target_path}")
+                target_path.parent.mkdir(parents=True, exist_ok=True)
+                with zip_ref.open(member) as source, open(target_path, "wb") as target:
+                    target.write(source.read())
+
+    print(f"Done downloading and extracting libraries for {platform_name}")
+
+def copy_artifacts_to_root():
+    """Copy the artifacts folder from scripts/artifacts to the root of the repository."""
+    if not SCRIPTS_ARTIFACTS_DIR.exists():
+        print("No artifacts found in scripts/artifacts")
+        return
+
+    print("Copying artifacts from scripts/artifacts to root...")
+    if ROOT_ARTIFACTS_DIR.exists():
+        shutil.rmtree(ROOT_ARTIFACTS_DIR)
+    shutil.copytree(SCRIPTS_ARTIFACTS_DIR, ROOT_ARTIFACTS_DIR)
+    print("Done copying artifacts")
+
+def main():
+    if len(sys.argv) < 2:
+        print("Usage: python download_artifacts.py <release_tag>")
+        print("Example: python download_artifacts.py c2pa-v0.49.5")
+        sys.exit(1)
+
+    release_tag = sys.argv[1]
+    try:
+        SCRIPTS_ARTIFACTS_DIR.mkdir(exist_ok=True)
+        print(f"Fetching release information for tag {release_tag}...")
+        release = get_release_by_tag(release_tag)
+        print(f"Found release: {release['tag_name']} \n")
+
+        # Get the platform identifier for the current system
+        env_platform = os.environ.get("C2PA_LIBS_PLATFORM")
+        if env_platform:
+            print(f"Using platform from environment variable C2PA_LIBS_PLATFORM: {env_platform}")
+        platform_id = env_platform or get_platform_identifier()
+        platform_source = "environment variable" if env_platform else "auto-detection"
+        print(f"Target platform: {platform_id} (set through{platform_source})")
+
+        # Construct the expected asset name
+        expected_asset_name = f"{release_tag}-{platform_id}.zip"
+        print(f"Looking for asset: {expected_asset_name}")
+
+        # Find the matching asset in the release
+        matching_asset = None
+        for asset in release['assets']:
+            if asset['name'] == expected_asset_name:
+                matching_asset = asset
+                break
+
+        if matching_asset:
+            print(f"Found matching asset: {matching_asset['name']}")
+            download_and_extract_libs(matching_asset['browser_download_url'], platform_id)
+            print("\nArtifacts have been downloaded and extracted successfully!")
+            copy_artifacts_to_root()
+        else:
+            print(f"\nNo matching asset found: {expected_asset_name}")
+
+    except requests.exceptions.RequestException as e:
+        print(f"Error: {e}")
+        sys.exit(1)
+    except Exception as e:
+        print(f"Error: {e}")
+        sys.exit(1)
+
+if __name__ == "__main__":
+    main()

c2pa_python-0.10.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+