update python and add python cffi example (#63)

* rename python folder to python_cffi

* make sure it works with newest core version

* add python jsonrpc

Author: Simon-Laux

README.md

@@ -10,7 +10,8 @@ An echo bot in multiple languages to get you started.
 | [Go](./go)                                                   | `1.110.0`    |
 | [node.js over cffi](./nodejs_cffi)                           | `1.132.1`    |
 | [node.js over jsonrpc](./nodejs_napi_jsonrpc) (unmaintained) | `1.101.0`    |
-| [Python](./python)                                           | `1.94.0`     |
+| [Python over cffi](./python_cffi)                            | `1.132.1`    |
+| [Python over jsonrpc](./python_jsonrpc)                      | `1.132.1`    |
 | [Rust](./rust)                                               | `1.132.1`    |
 
 ### With abstraction layer / bot framework:

python/.gitignore python_cffi/.gitignore

@@ -1,7 +1,10 @@
-# Python
+# Python (CFFI)
 
-> There are 2 alternative options available:
+> There are 3 alternative options available:
 >
+> using the newer [jsonrpc based bindings](../python_jsonrpc)
+>
+> frameworks:
 > - [using deltabot](../python_deltabot_plugin) (bot framework, includes features as chat command parsing)
 > - [using simplebot](../python_simplebot_plugin) (simplebot is a maintained fork of deltabot with many plugins availible)
 
@@ -15,8 +18,11 @@ source .venv/bin/activate
 pip3 install -U pip wheel
 
 # install deltachat
-pip3 install deltachat # if it doesn't work, see https://github.com/deltachat/deltachat-core-rust/tree/master/python for instructions on how to install it from source
+pip3 install deltachat
 ```
+If it doesn't work (for example because you are not on linux),
+see https://py.delta.chat/cffi/install.html#installing-bindings-from-source for instructions on how to install it from source.
+
 
 ## Usage
 
@@ -27,6 +33,6 @@ python echo_bot.py /tmp/db --email ADDRESS --password PASSWORD
 ### References
 
 - all available hooks can be found in https://github.com/deltachat/deltachat-core-rust/blob/master/python/src/deltachat/hookspec.py
-- Python bindings documentation py.delta.chat
-- https://py.delta.chat/examples.html
+- Python bindings documentation https://py.delta.chat
+- https://py.delta.chat/cffi/examples.html
 - source code of python bindings https://github.com/deltachat/deltachat-core-rust/tree/master/python

python/README.md python_cffi/README.md

@@ -6,7 +6,7 @@ a pluggable deltachat bot.
 > There are 2 alternative options available:
 >
 > - [using simplebot](../python_simplebot_plugin) (simplebot is a maintained fork of deltabot with many plugins availible)
-> - [using python directly](../python) (more controll, but also more code to take care of)
+> - [using python directly](../python_cffi) (more controll, but also more code to take care of)
 
 ## Usage
 

python/echo_bot.py python_cffi/echo_bot.py

@@ -0,0 +1,2 @@
+/.venv
+accounts

python_deltabot_plugin/README.MD

@@ -0,0 +1,53 @@
+# Python (CFFI)
+
+> There are 3 alternative options available:
+>
+> using the older legacy [cffi based bindings](../python_cffi)
+>
+> frameworks:
+> - [using deltabot](../python_deltabot_plugin) (bot framework, includes features as chat command parsing)
+> - [using simplebot](../python_simplebot_plugin) (simplebot is a maintained fork of deltabot with many plugins availible)
+
+## Installation
+
+```sh
+# Optional create virtualenv
+pip3 install virtualenv
+virtualenv .venv
+source .venv/bin/activate
+
+# install rpc server
+pip install deltachat-rpc-server
+# install client
+pip install deltachat-rpc-client
+```
+
+For alternative installation instructions refer to https://py.delta.chat/jsonrpc/install.html#install (building from souce or download prbuilds manually).
+
+## Usage
+
+set credentials
+```sh
+# mac & linux
+export [email protected]
+export MAIL_PW="my_password"
+# windows
+set [email protected]
+set MAIL_PW="my_password"
+```
+
+start the bot:
+```
+python echo_bot.py /tmp/dc-accounts
+```
+
+or start the version made with the hook system:
+```
+python ./echo_bot_with_hooks.py --email $MAIL_ADDR --password $MAIL_PW
+```
+
+### References
+
+- Python bindings documentation https://py.delta.chat
+- https://py.delta.chat/jsonrpc/examples.html
+- source code of python bindings https://github.com/deltachat/deltachat-core-rust/tree/master/deltachat-rpc-client

python_jsonrpc/.gitignore

@@ -0,0 +1,57 @@
+#!/usr/bin/env python3
+"""
+Example echo bot without using hooks
+"""
+import logging
+import sys
+import os
+
+from deltachat_rpc_client import DeltaChat, EventType, Rpc, SpecialContactId
+
+
+def main():
+    with Rpc() as rpc:
+        deltachat = DeltaChat(rpc)
+        system_info = deltachat.get_system_info()
+        logging.info("Running deltachat core %s", system_info["deltachat_core_version"])
+
+        accounts = deltachat.get_all_accounts()
+        account = accounts[0] if accounts else deltachat.add_account()
+
+        account.set_config("bot", "1")
+        if not account.is_configured():
+            logging.info("Account is not configured, configuring")
+            account.set_config("addr", os.environ['MAIL_ADDR'])
+            account.set_config("mail_pw", os.environ['MAIL_PW'])
+            account.configure()
+            logging.info("Configured")
+        else:
+            logging.info("Account is already configured")
+            deltachat.start_io()
+
+        def process_messages():
+            for message in account.get_next_messages():
+                snapshot = message.get_snapshot()
+                if snapshot.from_id != SpecialContactId.SELF and not snapshot.is_bot and not snapshot.is_info:
+                    snapshot.chat.send_text(snapshot.text)
+                snapshot.message.mark_seen()
+
+        # Process old messages.
+        process_messages()
+
+        while True:
+            event = account.wait_for_event()
+            if event["kind"] == EventType.INFO:
+                logging.info("%s", event["msg"])
+            elif event["kind"] == EventType.WARNING:
+                logging.warning("%s", event["msg"])
+            elif event["kind"] == EventType.ERROR:
+                logging.error("%s", event["msg"])
+            elif event["kind"] == EventType.INCOMING_MSG:
+                logging.info("Got an incoming message")
+                process_messages()
+
+
+if __name__ == "__main__":
+    logging.basicConfig(level=logging.INFO)
+    main()

python_jsonrpc/README.md

@@ -0,0 +1,24 @@
+#!/usr/bin/env python3
+"""Minimal echo bot example.
+
+it will echo back any text send to it, it also will print to console all Delta Chat core events.
+Pass --help to the CLI to see available options.
+"""
+from deltachat_rpc_client import events, run_bot_cli
+
+hooks = events.HookCollection()
+
+
+@hooks.on(events.RawEvent)
+def log_event(event):
+    print(event)
+
+
+@hooks.on(events.NewMessage)
+def echo(event):
+    snapshot = event.message_snapshot
+    snapshot.chat.send_text(snapshot.text)
+
+
+if __name__ == "__main__":
+    run_bot_cli(hooks)

python_jsonrpc/echo_bot.py

@@ -7,7 +7,7 @@ which is a fork of [deltabot](https://github.com/deltachat-bot/deltabot) and has
 > There are 2 alternative options available:
 >
 > - [using deltabot](../python_deltabot_plugin) (similar to simplebot, but less plugins)
-> - [using python directly](../python) (more control, but also more code to take care of)
+> - [using python directly](../python_cffi) (more control, but also more code to take care of)
 
 ## Usage