Skip to main content

Python SDK for ContactsManager API authentication and token generation

Project description

ContactsManager Python SDK

A Python SDK for the ContactsManager API that handles authentication and token generation.

Installation

pip install contactsmanager

Usage

from contactsmanager import ContactsManagerClient

# Initialize the client
client = ContactsManagerClient(
    api_key="your_api_key",
    api_secret="your_api_secret",
    org_id="your_org_id"
)

# Generate a token for a user
token_response = client.generate_token(
    user_id="user123",
    device_info={  # Optional
        "device_type": "mobile",
        "os": "iOS",
        "app_version": "1.0.0"
    }
)

print(f"Token: {token_response['token']}")
print(f"Expires at: {token_response['expires_at']}")

Features

  • Simple API for generating JWT tokens
  • Type hints for better IDE support
  • Comprehensive test coverage
  • Support for custom token expiration

Advanced Usage

Custom Token Expiration

By default, tokens expire after 24 hours (86400 seconds). You can customize this:

# Generate a token that expires in 1 hour
token_response = client.generate_token(
    user_id="user123",
    expiration_seconds=3600  # 1 hour
)

Requirements

  • Python 3.8+
  • PyJWT>=2.0.0

Development

Setting up development environment

# Clone the repository
git clone https://github.com/arpwal/contactmanager.git
cd contactmanager/sdk/py

# Install development dependencies
pip install -e ".[dev]"

# Run tests
pytest

Releasing new versions

The SDK uses an automated process for releases:

  1. Update the version in contactsmanager/__init__.py using the provided script:

    ./bump_version.sh 0.1.1
    
  2. Commit and push the change to the main branch:

    git add contactsmanager/__init__.py
    git commit -m "Bump version to 0.1.1"
    git push origin main
    
  3. The GitHub Actions workflow will:

    • Run all tests across multiple Python versions
    • Create a new GitHub release with the version tag
    • Build and publish the package to PyPI

Alternatively, you can manually create a new release by:

  1. Creating and pushing a git tag:

    git tag -a v0.1.1 -m "Release version 0.1.1"
    git push origin v0.1.1
    
  2. The GitHub Actions workflow will handle the rest

License

MIT License

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

contactsmanager-1.0.1.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.

contactsmanager-1.0.1-py3-none-any.whl (4.7 kB view details)

Uploaded Python 3

File details

Details for the file contactsmanager-1.0.1.tar.gz.

File metadata

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

File hashes

Hashes for contactsmanager-1.0.1.tar.gz
Algorithm Hash digest
SHA256 88be045690e0fbd1567208e14fbb60ac9034484ee1adb79d8248bccd3672a8d7
MD5 ab3a99bcd86ee62a0c55d16222e7c6ef
BLAKE2b-256 efa3ab7d1453e6ae37387762c57bd7c12a16169e1ed18d2321c6fce7ddcd6490

See more details on using hashes here.

File details

Details for the file contactsmanager-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for contactsmanager-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9ffe3126a97f48a51d1cf954974d85292cd30bc35a91ca8f41418d7b84f1f3b8
MD5 c25a47e6bde50d8830406896d7e69400
BLAKE2b-256 fda8f822b2096db36d8ac74997a71d1175d347e320c3e5619d983f6125fd32ea

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