Skip to main content

The official Python library for the Chat Nio API

Project description

ChatNio Python Library

The official Python library for the Chat Nio API

Features

  • Chat

  • Conversation

  • Quota

  • Subscription and Package

Installation

Install using pip

pip install --upgrade chatnio

And then import it

import chatnio

Usage

  • Authentication

chatnio.set_key("sk-...")
# or read from environment variable
chatnio.set_key_from_env("CHATNIO_TOKEN")

# set custom api endpoint (default: https://api.chatnio.net)
# chatnio.set_endpoint("https://example.com/api")

# clear token
chatnio.clear_key()

# get current token
chatnio.get_token()
  • Chat

chat = await chatnio.new_chat()

async for message in chat.ask("Hello, world!"):
    print(message.message, end="")
  • Conversation

# list conversations (100 conversations max)
for conversation in chatnio.list_conversations():
    print(conversation.id, conversation.name)

# load conversation
conversation = chatnio.load_conversation(42)
print(conversation)
for message in conversation.messages:
    print(message.role, message.content)

# delete conversation
state = chatnio.delete_conversation(42)
print(state)
  • Quota

# get quota
quota = chatnio.get_quota()
print(quota)

# buy quota
state = chatnio.buy_quota(1000)
print(state)
  • Subscription and Package

# get subscription
subscription = chatnio.get_subscription()
print(subscription.is_subscribed, subscription.expired)

# buy subscription
state = chatnio.buy_subscription(1, 1) # 1 month of basic plan
print(state)

# get package
package = chatnio.get_package()
print(package)
  • Error

    chatnio.AuthenticationError

Test

To run the tests, you need to set the environment variable CHATNIO_TOKEN to your secret key.

export CHATNIO_TOKEN="sk-..."

Then run the tests

pytest

History

  • 0.1.0 (2023-10-13)
    • First release on PyPI.

  • 0.1.1 (2023-10-14)
    • Update Documentation

  • 0.1.2 (2023-10-31)
    • Update API

  • 0.1.3 (2023-11-29)
    • Add Subscription Level

  • 0.1.4 (2023-12-01)
    • Add Customize Endpoint Option

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

chatnio-0.1.4.tar.gz (15.4 kB view hashes)

Uploaded Source

Built Distribution

chatnio-0.1.4-py2.py3-none-any.whl (9.5 kB view hashes)

Uploaded Python 2 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