Python library simplifies the process of authenticating accounts with TP Servers.
Project description
tj-tpauth
tj-tpauth
is a Python library for managing user authentication through an API. The library supports both synchronous
and asynchronous methods for login and token-based authentication.
Installation
To install the library, use pip:
pip install tj-tpauth
Usage
Synchronous (Sync)
from tj_tpauth import TJTPAuth
# Initialize TJTPAuth object with API URL and optional timeout
tpauth = TJTPAuth(
host='http://localhost:3000',
timeout=10
)
# Log in with username and password
login_status = tpauth.login(
username='username',
password='password'
)
# Check login status
if not login_status.status:
exit(0)
# Authenticate with token
auth_status = tpauth.from_token(login_status.data.token)
# Check authentication status
if not auth_status.status:
exit(0)
# Print authentication data
print(auth_status.data)
Asynchronous (Async)
import asyncio
from tj_tpauth import TJTPAuth
# Initialize TJTPAuth object with API URL and optional timeout
tpauth = TJTPAuth(
host='http://localhost:3000',
timeout=10
)
async def main():
# Log in with username and password
login_status = await tpauth.aio_login(
username='username',
password='password'
)
# Check login status
if not login_status.status:
exit(0)
# Authenticate with token
auth_status = await tpauth.aio_from_token(login_status.data.token)
# Check authentication status
if not auth_status.status:
exit(0)
# Print authentication data
print(auth_status.data)
# Run asynchronous function
asyncio.run(main())
Main Classes
TPAuthData
: Contains user authentication information.TPAuthStatus
: Represents the authentication status, including error information.TJTPAuth
: Provides synchronous and asynchronous methods for login and token-based authentication.
Error Handling
Error.NOTHING
: No error.Error.TIMEOUT
: Timeout error.Error.UNAUTHORIZED
: Unauthorized error.Error.PARSING
: Data parsing error.
References
For more information about requests
and aiohttp
, refer to their official documentation:
License
This library is released under the MIT License.
Contact
If you have any questions or issues, please open an issue on GitHub or email us at duynguyen02.dev@gmail.com.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
tj_tpauth-1.1.0.tar.gz
(3.5 kB
view hashes)
Built Distribution
Close
Hashes for tj_tpauth-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 60f26b54f5939f47c8e5d605889cd037989e32a6f15e3f85d9caea812660e3be |
|
MD5 | 47e769d10987665a9e813ef9079783d0 |
|
BLAKE2b-256 | a5ce3df1d9284fa29edfda0d32d9221c2d4aec16ce780bb608b1a4fadb09a998 |