Skip to main content

Python client for True Checker API

Project description

True Checker for Python

Python client library for True Checker API

How to install

pip install truechecker

How to use

# import TrueChecker
from truechecker import TrueChecker


# create an instance (poss your Telegram bot token here)
checker = TrueChecker("your_bot_token")


# prepare a file with users ids
# you should use string path, pathlib.Path object or io.BaseFile
file_path = "downloads/users.csv"


# send request to create a new job
job = await checker.check_profile(file_path)
print("Job created. ID:", job.id)


# get the status of job
job = await checker.get_job_status(job.id)
print("Job state:", job.state)
print("Job progress:", job.progress)


# if the job is done, let's get the profile
profile = await checker.get_profile("my_bot_username")
print("Bot profile:", profile)


# if you need to cancel the job
job = await checker.cancel_job(job.id)
print("Job state:", job.state)  # Cancelled


# Don't forget to close checker on your app's on_shutdown
await checker.close()

CAUTION: it's not a full code example. Await statements should be used within coroutines only.

Contributing

Before making Pull/Merge Requests, please read the Contributing guidelines

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

truechecker-2021.10.11.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

truechecker-2021.10.11-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

Details for the file truechecker-2021.10.11.tar.gz.

File metadata

  • Download URL: truechecker-2021.10.11.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.8.12 Linux/5.4.109+

File hashes

Hashes for truechecker-2021.10.11.tar.gz
Algorithm Hash digest
SHA256 69a1642d478b738f7f00d7ec46219692bace65d6b47ff223e05beb4b83999f5d
MD5 3d49bb67abf68d8a02ea2a7c6a0cb431
BLAKE2b-256 73684993b387c88fb3ec6c78a10a5a6264b596b568632341dce9a94d40cfce90

See more details on using hashes here.

File details

Details for the file truechecker-2021.10.11-py3-none-any.whl.

File metadata

  • Download URL: truechecker-2021.10.11-py3-none-any.whl
  • Upload date:
  • Size: 8.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.8.12 Linux/5.4.109+

File hashes

Hashes for truechecker-2021.10.11-py3-none-any.whl
Algorithm Hash digest
SHA256 e2915a1b14bfafe85d4d49065863f3b0f3aec08bdbb40735ff32f7a2448b475d
MD5 ba0b720c39a4fb4e81f49027006bc6ed
BLAKE2b-256 d742677fd6b54b22829b9b23689caee21718abed055591cac84b33821166e719

See more details on using hashes here.

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