Installation#

Note

TGBOX library require Python version 3.8 or above.

PyPI (pip)#

python3 -m pip install tgbox # Pure Python (very slow)
python3 -m pip install tgbox[fast] # With C libraries

Clone from GitHub#

git clone https://github.com/NonProjects/tgbox
python3 -m pip install ./tgbox/[fast]

Optional dependencies#

  • Library can work in a Pure Python way, without cryptography, by using pyaes and ecdsa, but this will be much slower and not secure. Pure Python is not recommended for serious usage, but testing-only is OK!

Note

The cryptography project has wheels for many systems. Big chance that you will not need to compile a C code, so always try to install tgbox[fast].

  • Library will use the Regex python package (PyPI) if it’s installed in environment.

  • With FFmpeg, library can make previews for media files and extract duration to attach it to the RemoteBox File. To work, it should be in your System PATH (see more about PATH). We will call it as ffmpeg (tgbox.defaults.FFMPEG) shell command via subprocess.