toxygen_wrapper/README.md

42 lines
1.4 KiB
Markdown
Raw Normal View History

2022-09-24 05:41:12 +02:00
# toxygen_wrapper
2022-09-24 06:35:33 +02:00
ctypes wrapping of [Tox](https://tox.chat/) libtoxcore
2022-09-25 09:21:16 +02:00
<https://github.com/TokTok/c-toxcore> into Python.
Taken from the wrapper directory of the now abandoned
2022-09-24 06:35:33 +02:00
<https://github.com/toxygen-project/toxygen> `next_gen` branch
by Ingvar.
2022-09-25 09:21:16 +02:00
The basics of NGC groups are supported, as well as AV and toxencryptsave.
2022-09-24 06:00:03 +02:00
## Install
Put the parent of the wrapper directory on your PYTHONPATH and
touch a file called `__init__.py` in the parent directory.
## Prerequisites
2022-09-24 06:35:33 +02:00
No prerequisites in Python3.
2022-09-24 06:00:03 +02:00
2022-09-24 06:35:33 +02:00
## Other wrappers
2022-09-24 06:00:03 +02:00
There are a number of other wrappings into Python of Tox core.
This one uses CTYPES which has its merits - there is no need to
recompile anything as with Cython - change the Python file and it's done.
2022-09-25 09:21:16 +02:00
CTYPES code can be brittle, segfaulting if you've got things wrong,
2022-09-24 06:35:33 +02:00
but if your wrapping is right, it is very efficient and easy to work on.
2022-09-24 06:00:03 +02:00
Others include:
2022-09-24 06:35:33 +02:00
* <https://github.com/TokTok/py-toxcore-c> Cython bindings.
Incomplete and not really actively supported. Maybe it will get
worked on in the future, but TokTok seems to be working on
2022-09-25 09:21:16 +02:00
java, rust, scalla, go, etc. bindings instead.
No support for NGC groups or toxencryptsave.
2022-09-24 06:35:33 +02:00
* <https://github.com/oxij/PyTox>
forked from https://github.com/aitjcize/PyTox
by Wei-Ning Huang <aitjcize@gmail.com>.
2022-09-25 09:21:16 +02:00
Hardcore C wrapping which is not easy to keep up to date.
No support for NGC or toxencryptsave. Abandonned.
This was the basis for the TokTok/py-toxcore-c code until recently.