Skip to main content

Python SDK for Friendify API

Project description

Friendify Python SDK

The official Python SDK for the Friendify API. Build rich integrations and bots for the Friendify ecosystem.

Installation

pip install friendify-sdk

(Or clone the repository and install locally via pip install .)

Quick Start

Initialize the client with your access token (or bot token):

from friendify.client import FriendifyClient

client = FriendifyClient(token="YOUR_TOKEN_HERE")

# Get current user profile
me = client.users.get_me()
print(me)

# Search users
search_results = client.users.search(query="john", limit=5)
print(search_results)

# Execute a bot action in a group
action_result = client.groups.send_message(group_id="GROUP_ID_HERE", content="Hello from Python!")
print(action_result)

# Award XP to the user
xp_result = client.xp.award(action="DAILY_LOGIN", multiplier=1.5)
print(xp_result)

Resources

  • client.users: Manage users, fetch profiles, search, and check limits.
  • client.groups: Manage group bots, roles, and execute bot actions.
  • client.xp: Award XP for users completing specific actions.
  • client.notify: Dispatch push notifications.

All methods are documented thoroughly with Docstrings, providing autocomplete and tooltips in your IDE.

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

friendify_sdk-0.1.0.tar.gz (4.7 kB view details)

Uploaded Source

Built Distribution

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

friendify_sdk-0.1.0-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

Details for the file friendify_sdk-0.1.0.tar.gz.

File metadata

  • Download URL: friendify_sdk-0.1.0.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for friendify_sdk-0.1.0.tar.gz
Algorithm Hash digest
SHA256 3949eb9bb6752a650e49226a3e373987b8c479bd5d9985495511a07d8ef01985
MD5 53929c4a971e2378af0e8f93b52940de
BLAKE2b-256 65137fd966f711417c132fa60c8799df71611ad1eb9395cb0dd32a9a5e3790b6

See more details on using hashes here.

File details

Details for the file friendify_sdk-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: friendify_sdk-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 6.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for friendify_sdk-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1306fad6691eedd2d22cf00b0aee11a668dccdd0b7dd0a9916b184ecbb37382c
MD5 9fa0ee443a91acbfd92b716db44241fb
BLAKE2b-256 b352e62a69b33d86466e22ef2093ff152e133f523bf4cda20f428b2038fd18c7

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