emdee/toxygen_wrapper
1
0
Fork 0
Code Issues Pull Requests Actions Projects Wiki Activity

Update README

Browse Source
This commit is contained in:
emdee 2022-09-26 04:54:59 +00:00
parent 2187568ef8
commit 5a938b40b4
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -1,10 +1,10 @@
# toxygen_wrapper # toxygen_wrapper
[ctypes](https://docs.python.org/3/library/ctypes.html) [ctypes](https://docs.python.org/3/library/ctypes.html)
wrapping of [Tox](https://tox.chat/) ```libtoxcore``` wrapping of [Tox](https://tox.chat/)
<https://github.com/TokTok/c-toxcore> into Python. [```libtoxcore```](https://github.com/TokTok/c-toxcore) into Python.
Taken from the ```wrapper``` directory of the now abandoned Taken from the ```wrapper``` directory of the now abandoned
<https://github.com/toxygen-project/toxygen> `next_gen` branch <https://github.com/toxygen-project/toxygen> ```next_gen``` branch
by Ingvar. by Ingvar.
The basics of NGC groups are supported, as well as AV and toxencryptsave. The basics of NGC groups are supported, as well as AV and toxencryptsave.
@ -12,7 +12,7 @@ There is no coverage of conferences as they are not used in ```toxygen```
and the list of still unwrapped calls as of Sept. 2022 can be found in and the list of still unwrapped calls as of Sept. 2022 can be found in
```tox.c-toxcore.missing```. The code still needs double-checking ```tox.c-toxcore.missing```. The code still needs double-checking
that every call in ```tox.py``` has the right signature, but it runs that every call in ```tox.py``` has the right signature, but it runs
```toxygen``` with apparent issues. ```toxygen``` with no apparent issues.
It has been tested with UDP and TCP proxy (Tor). It has ***not*** been It has been tested with UDP and TCP proxy (Tor). It has ***not*** been
tested on Windows, and there may be some minor breakage, which should be tested on Windows, and there may be some minor breakage, which should be
@ -42,10 +42,13 @@ This one uses [ctypes](https://docs.python.org/3/library/ctypes.html)
which has its merits - there is no need to recompile anything as with which has its merits - there is no need to recompile anything as with
Cython - change the Python file and it's done. And you can follow things Cython - change the Python file and it's done. And you can follow things
in a Python debugger, or with the utterly stupendous Python feature of in a Python debugger, or with the utterly stupendous Python feature of
```gdb`` (```gdb -ex r --args /usr/bin/python3.9 <pyfile>```). ```gdb``` (```gdb -ex r --args /usr/bin/python3.9 <pyfile>```).
CTYPES code can be brittle, segfaulting if you've got things wrong, CTYPES code can be brittle, segfaulting if you've got things wrong,
but if your wrapping is right, it is very efficient and easy to work on. but if your wrapping is right, it is very efficient and easy to work on.
The [faulthandler](https://docs.python.org/3/library/faulthandler.html)
module can be helpful in debugging crashes
(e.g. from segmentation faults produced by erroneous C library wrapping).
Others include: Others include: