passes-rs-py 4.0.0

Rust library for generate Apple Wallet Passes for iOS, WatchOS, MacOS.

Passes

A Rust library for generating PassKit passes, featuring:

• Read & parse .pkpass files
• Build & make passes by using library API
• Sign passes with certificate and compress to .pkpass
• Change field values is pass by key name
• Supported semantic tags for pass & fields
• All features of Wallet Passes standard represented in library

Documentation:

• API reference (doc.rs)
• Examples
• Apple Wallet Documentation

Developer Setup

Quick Start (Recommended)

macOS/Linux:

chmod +x dev-setup.sh
./dev-setup.sh

Windows:

dev-setup.bat

This will:

• Install Rust (if needed)
• Install maturin (Python-Rust build tool)
• Create a Python virtual environment
• Build and install the package in development mode

Manual Setup

1. Install Rust:

   curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
   

2. Install Python dependencies:

   pip install maturin
   

3. Build for development:

   maturin develop
   

4. Test the installation:

   import passes_rs_py
   

Development Commands

• Build for development: maturin develop
• Build release wheel: maturin build --release
• Run Rust tests: cargo test
• Format code: cargo fmt

Usage

Add this to your Cargo.toml:

[dependencies]
neopasses = "0.1.0"

Example

Rust API

For building simple pass:

// Creating pass
let pass = PassBuilder::new(PassConfig {
    organization_name: "Test organization".into(),
    description: "Super gentlememe pass".into(),
    pass_type_identifier: "com.example.pass".into(),
    team_identifier: "AA00AA0A0A".into(),
    serial_number: "ABCDEFG1234567890".into(),
})
.grouping_identifier(String::from("com.example.pass.app"))
.logo_text("Test pass".into())
.build();

Creating package and generate .pkpass file:

let mut package = Package::new(pass);

// Save package as .pkpass
let path = Path::new("test_pass.pkpass");
let file = match File::create(&path) {
    Err(why) => panic!("couldn't create {}: {}", path.display(), why),
    Ok(file) => file,
};
package.write(file).unwrap();

Python Bindings

The library also provides Python bindings with comprehensive asset support:

from passes_rs_py import generate_pass

# Generate pass with multiple asset types
generate_pass(
    config=pass_json_config,
    cert_path="path/to/cert.pem",
    key_path="path/to/key.key",
    output_path="output.pkpass",
    
    # All asset types supported
    icon_path="assets/icon.png",
    icon2x_path="assets/[e-mail]",
    logo_path="assets/logo.png",
    logo2x_path="assets/[e-mail]",
    thumbnail_path="assets/thumbnail.png",
    thumbnail2x_path="assets/[e-mail]",
    strip_path="assets/strip.png",
    strip2x_path="assets/[e-mail]",
    background_path="assets/background.png",
    background2x_path="assets/[e-mail]",
    footer_path="assets/footer.png",
    footer2x_path="assets/[e-mail]",
)

Supported Asset Types

• Icons: icon_path, icon2x_path - Lock screen and app display
• Logos: logo_path, logo2x_path - Top-left corner branding
• Thumbnails: thumbnail_path, thumbnail2x_path - Field area images
• Strip images: strip_path, strip2x_path - Behind primary fields
• Backgrounds: background_path, background2x_path - Full pass background
• Footers: footer_path, footer2x_path - Near barcode area

All asset parameters are optional. See ASSETS.md for detailed documentation.

For more examples, see examples directory.

License

Passes is distributed under the terms of the MIT license. See LICENSE.