deltachat-core

mirror of https://github.com/deltachat/deltachat-core.git synced 2025-10-03 17:59:19 +02:00

History

holger krekel da78552622 - make set_config() more like the c-version but make configure() accept **kwargs - some safety checks: you can't modify addr after successful configure		2018-09-24 20:27:18 +02:00
..
doc	integrate doxygen's deltachat.h docs into sphinx output	2018-09-16 23:25:57 +02:00
src/deltachat	- make set_config() more like the c-version but make configure() accept **kwargs	2018-09-24 20:27:18 +02:00
tests	- make set_config() more like the c-version but make configure() accept **kwargs	2018-09-24 20:27:18 +02:00
.gitignore	improve docs and structure	2018-09-14 18:10:01 +02:00
CHANGELOG	initial sphinx docs and many docstrings.	2018-09-14 11:36:07 +02:00
conftest.py	- make set_config() more like the c-version but make configure() accept **kwargs	2018-09-24 20:27:18 +02:00
README.rst	fixup some doc pages, and canonically handle another __del__ function	2018-09-14 12:40:26 +02:00
setup.cfg	try fix travis and a spurious exception on __del__ time -- only do something if module globals are not None, some other fixups	2018-09-14 12:13:57 +02:00
setup.py	initial sphinx docs and many docstrings.	2018-09-14 11:36:07 +02:00
tox.ini	integrate doxygen's deltachat.h docs into sphinx output	2018-09-16 23:25:57 +02:00

README.rst

deltachat python bindings
=========================

This package provides bindings to the delta-core_ C-library
which provides imap/smtp/crypto handling as well as chat/group/messages
handling to Android, Desktop and IO user interfaces.

Install
-------

.. note::

    Currently the install instructions exist only for Debian based systems (Ubuntu etc.).

First you need to execute all the build steps to install the delta-core C-library,
see https://github.com/deltachat/deltachat-core/blob/master/README.md#build

Presuming you have the delta-core library installed, you can then from the root of the repo::

    cd python
    pip install -e .

Afterwards you should be able to successfully import the bindings::

    python -c "import deltachat"


Running tests
-------------

Install the delta-core C-library and the deltachat bindings (see _Install)
and then type the following to execute tests::

    pip install tox
    tox

If you want to run functional tests that run against real
e-mail accounts, generate a "liveconfig" file where each
lines contains account settings, for example::

    # 'liveconfig' file specifying imap/smtp accounts
    addr=some-email@example.org mail_pw=password
    addr=other-email@example.org mail_pw=otherpassword

And then run the tests with this live-accounts config file::

    tox -- --liveconfig liveconfig


.. _`delta-core`: https://github.com/deltachat/deltachat-core