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

some more refinements and typo fixes

Browse source
This commit is contained in:
holger krekel 2018-09-27 16:40:59 +02:00
parent 4d22bcd783
commit 690ba67c8b
2 changed files with 12 additions and 69 deletions
Download patch file Download diff file Expand all files Collapse all files

54
python/doc/install.rst
View file

@ -1,54 +1,2 @@
building and installing deltachat
======================================
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.
build
-------
.. 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
install
-------
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
.. include:: ../README.rst