Skip to main content

Client for interacting with Pinapple

Project description

🍍 PinappleClient

A Python client for interacting with the Pinapple encryption API.

🚀 Features

  • Authentication 🔐 - Token-based API authentication
  • Flexible Encryption ⚡ - Support for strict and loose encryption modes
  • Fallback Strategy 🔄 - Automatic fallback from strict to loose encryption

📦 Installation

pip install PinappleClient

🔧 Quick Start

from pinapple_client import PinappleClient

# Initialize client
client = PinappleClient(
    user="your_username",
    password="your_password",
    api_url="https://api.pinapple.com"
)

# Encrypt a single PIN
encrypted_pin = client.encrypt_pin_strict("123456")
print(f"Encrypted: {encrypted_pin}")

# Decrypt data
decrypted_pin = client.decrypt_pin(encrypted_data)
print(f"Decrypted: {decrypted_pin}")

📊 DataFrame Operations

encrypt_dataframe(df, column, strict=True, strict_then_loose=False) -> DataFrame

Encrypts an entire column in a pandas DataFrame.

import pandas as pd

df = pd.DataFrame({
    'id': [1, 2, 3],
    'pin': ['123456', '789012', '345678']
})

# Encrypt the 'pin' column
encrypted_df = client.encrypt_dataframe(df, 'pin', strict=True)

# Use fallback strategy
encrypted_df = client.encrypt_dataframe(df, 'pin', strict_then_loose=True)

Parameters:

  • df: Input DataFrame
  • column: Column name to encrypt
  • strict: Use strict encryption (default: True)
  • strict_then_loose: Enable fallback strategy (default: False)

🔒 Authentication

The client automatically handles token management:

  1. Requests a bearer token on first API call
  2. Caches the token for subsequent requests
  3. Automatically includes authentication headers

📄 License

This project is licensed under the GPL-3.0 License.

🔗 Links

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pinappleclient-1.1.4.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pinappleclient-1.1.4-py3-none-any.whl (5.4 kB view details)

Uploaded Python 3

File details

Details for the file pinappleclient-1.1.4.tar.gz.

File metadata

  • Download URL: pinappleclient-1.1.4.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for pinappleclient-1.1.4.tar.gz
Algorithm Hash digest
SHA256 08c655881234d619ba73ee0d11d7656325633123368ad8696827ac16b8ee559e
MD5 2dd545e0faebbfbc1cbd5484b934c0c1
BLAKE2b-256 f8a0bf628548c092e94f36c1bc29d6dca3f36b59b5b52686b80a4bef04b9ca94

See more details on using hashes here.

File details

Details for the file pinappleclient-1.1.4-py3-none-any.whl.

File metadata

  • Download URL: pinappleclient-1.1.4-py3-none-any.whl
  • Upload date:
  • Size: 5.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for pinappleclient-1.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 818c01c01529b3ea57f35a6fb4d8bc9c22b48d5584f132a98f4956c17115f2d6
MD5 04977bee7d578d9007f8c7dbba4cbf19
BLAKE2b-256 052d8127a489cbf2529acda3d1f78c7dc26ae28e7a0837d0b70c2b600a0d16fe

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page