Metadata-Version: 2.1
Name: agora_token_builder
Version: 1.0.0
Summary: Agora Token Builder. RTC & RTM
Home-page: https://github.com/AgoraIO-Community/python-token-builder
Author: Dennis
Author-email: <dennis@agora.io>
License: UNKNOWN
Keywords: python,agora,token-builder
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# Agora Token Generator


# Description 
Token generator for building a token server with Python & the Agora RTM/RTC

## Installation
------------

```pip install agora-token-builder```

## Usage
------------

###### RTC Live Video Calling & Chat SDK

Build token with `int` UID:
```python
from agora_token_builder import RtcTokenBuilder

#Build token with uid
token = RtcTokenBuilder.buildTokenWithUid(appId, appCertificate, channelName, uid, role, privilegeExpiredTs)
```
Build token with `string` UserAccount:
```python
from agora_token_builder import RtcTokenBuilder

#Build token with userAccount
token = RtcTokenBuilder.buildTokenWithAccount(appId, appCertificate, channelName, account, role, privilegeExpiredTs)
```

###### RTM Real-Time Messaging & Chat SDK
Build RTM token.
```python
from agora_token_builder import RtmTokenBuilder

token = RtmTokenBuilder.buildToken(appID, appCertificate, userAccount, role, privilegeExpiredTs)
```



## Variable Definitions

```appID```
<br>
The App ID issued to you by Agora. Apply for a new App ID from the gora Dashboard if it is missing from your kit. See Get an App ID.

```appCertificate```
<br>
	Certificate of the application that you registered in the Agora Dashboard. See Get an App Certificate.

```channelName```
<br>
Unique channel name for the AgoraRTC session in the string format

```uid```
<br>
User ID. A 32-bit unsigned integer with a value ranging from 1 to (232-1). optionalUid must be unique.

```userAccount```
A unique identifier used for to represent a user account. This value will be a string and can contain numbers, letters and any special characters.  

```role```
<br>
Role_Publisher = 1: A broadcaster (host) in a live-broadcast profile. Role_Subscriber = 2: (Default) A audience in a live-broadcast profile.

```privilegeExpireTs```
<br>
Represented by the number of seconds elapsed since 1/1/1970. If, for example, you want to access the Agora Service within 10 minutes after the token is generated, set expireTimestamp as the current


## License

© 2021 Agora.io

This repository is licensed under the MIT license. See LICENSE for details.


