Skip to main content

Python bindings for UserKit: user login and account management

Project description

Python UserKit

Summary

A UserKit client library for Python 3.

Installation

You can use pip to install userkit:

pip install userkit

Or download, then copy or symlink the userkit-python/userkit sub-directory into your project.

Documentation

For full examples and docs checkout UserKit documentation.

Example usage

import userkit
uk = userkit.UserKit("<YOUR_APP_SECRET_KEY>")

# Create a user
user = uk.users.create_user(email="jane.smith@example.com",
                            password="secretpass")

# Fetch a user
user = uk.users.get_user("<USER_ID>")

# Update a user
user = uk.users.update_user("<USER_ID>", name="Jane Smith")

# Login a user
session = uk.users.login_user("jane.smith@example.com", "secretpass")

# Fetch a logged in user by their session-token
user = uk.users.get_current_user(session.token)
if user:
    print("User is logged in:")
    print(user)
else:
    print("No logged in user, invalid session token")

Test

To run tests you need to create a test-app.

Set the USERKIT_KEY environment variable to your test app key, then run python's unittest:

USERKIT_KEY=<YOUR_APP_SECRET_KEY> python -m unittest discover

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

userkit-1.0.0.tar.gz (7.4 kB view hashes)

Uploaded Source

Built Distribution

userkit-1.0.0-py3-none-any.whl (11.4 kB view hashes)

Uploaded Python 3

Supported by

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