yetangitu/deltachat-core
1
0
Fork 0
mirror of https://github.com/deltachat/deltachat-core.git synced 2025-10-05 10:39:27 +02:00
Code Issues Releases Wiki Activity

add and check a simple readme, remove minversion, add some python/vim patterns to .gitignore

Browse source
This commit is contained in:
holger krekel 2018-09-09 17:41:09 +02:00
parent f09fa60a67
commit d2e437a550
5 changed files with 87 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

50
python/README.rst Normal file
View file

@ -0,0 +1,50 @@
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
Next, you need to do perform::
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 (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 for specifying real-life 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