| Name | matterdelta JSON |
| Version |
1.4.0
JSON |
| download |
| home_page | None |
| Summary | Matterbridge API plugin for Delta Chat |
| upload_time | 2024-04-27 21:12:12 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
deltachat
bot
matterbridge
bridge
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Matterdelta
[](https://pypi.org/project/matterdelta)
[](https://github.com/deltachat-bot/matterdelta/actions/workflows/python-ci.yml)
[](https://github.com/psf/black)
Matterdelta is a [Matterbridge](https://github.com/42wim/matterbridge) API plugin allowing to connect
Delta Chat group chats to the various chat services supported by Matterbridge.
## Install
```sh
pip install matterdelta
```
## Usage
Configure the bot's Delta Chat account:
```sh
matterdelta init bot@example.com PASSWORD
```
You can run `matterdelta init` several times to add multiple different accounts to the bot
so it can be reached in more than one email address.
The bot's display name, avatar and status/signature can also be tweaked:
```
matterdelta config selfavatar "/path/to/avatar.png"
matterdelta config displayname "Bridge Bot"
matterdelta config selfstatus "Hi, I am a Delta Chat bot"
```
To run the bot so it starts processing messages:
```sh
matterdelta serve
```
To see all available options run `matterdelta --help`
## Example Configuration
### matterbridge.toml
```
[api]
[api.deltachat]
BindAddress="127.0.0.1:4242"
Token="MATTERBRIDGE_TOKEN"
Buffer=1000
RemoteNickFormat="{NICK}"
...
[[gateway]]
name="gateway1"
enable=true
[[gateway.inout]]
account="api.deltachat"
channel="api"
...
```
Add these to your existing Matterbridge config to set up an API instance that Matterdelta can connect to.
### config.json
```
{
"gateways": [
{"gateway": "gateway1", "accountId": 1, "chatId": 1234}
],
"api": {
"url": "http://127.0.0.1:4242",
"token": "MATTERBRIDGE_TOKEN"
},
"quoteFormat": "{MESSAGE} (re @{QUOTENICK}: {QUOTEMESSAGE:.46})"
}
```
This file should be in Matterdelta's configuration directory, usually `~/.config/matterdelta/`
in Linux-based systems.
To get the `accountId` and `chatId` of the chat you want to bridge,
run the bot and add its address to your Delta Chat group, then send `/id` in the group,
the bot will reply with the account and chat id, then edit the configuration file and restart the bot.
Raw data
{
"_id": null,
"home_page": null,
"name": "matterdelta",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "deltachat, bot, matterbridge, bridge",
"author": null,
"author_email": "adbenitez <adb@merlinux.eu>",
"download_url": "https://files.pythonhosted.org/packages/1b/0a/8f0ae26654c4823f7593dc27e562a5808ec775e4abca59fb6dc98e3b29d0/matterdelta-1.4.0.tar.gz",
"platform": null,
"description": "# Matterdelta\n\n[](https://pypi.org/project/matterdelta)\n[](https://github.com/deltachat-bot/matterdelta/actions/workflows/python-ci.yml)\n[](https://github.com/psf/black)\n\nMatterdelta is a [Matterbridge](https://github.com/42wim/matterbridge) API plugin allowing to connect\nDelta Chat group chats to the various chat services supported by Matterbridge.\n\n## Install\n\n```sh\npip install matterdelta\n```\n\n## Usage\n\nConfigure the bot's Delta Chat account:\n\n```sh\nmatterdelta init bot@example.com PASSWORD\n```\n\nYou can run `matterdelta init` several times to add multiple different accounts to the bot\nso it can be reached in more than one email address.\n\nThe bot's display name, avatar and status/signature can also be tweaked:\n\n```\nmatterdelta config selfavatar \"/path/to/avatar.png\"\nmatterdelta config displayname \"Bridge Bot\"\nmatterdelta config selfstatus \"Hi, I am a Delta Chat bot\"\n```\n\nTo run the bot so it starts processing messages:\n\n```sh\nmatterdelta serve\n```\n\nTo see all available options run `matterdelta --help`\n\n## Example Configuration\n\n### matterbridge.toml\n\n```\n[api]\n [api.deltachat]\n BindAddress=\"127.0.0.1:4242\"\n Token=\"MATTERBRIDGE_TOKEN\"\n Buffer=1000\n RemoteNickFormat=\"{NICK}\"\n\n...\n\n[[gateway]]\nname=\"gateway1\"\nenable=true\n\n [[gateway.inout]]\n account=\"api.deltachat\"\n channel=\"api\"\n\n ...\n```\n\nAdd these to your existing Matterbridge config to set up an API instance that Matterdelta can connect to.\n\n### config.json\n\n```\n{\n \"gateways\": [\n {\"gateway\": \"gateway1\", \"accountId\": 1, \"chatId\": 1234}\n ],\n \"api\": {\n \"url\": \"http://127.0.0.1:4242\",\n \"token\": \"MATTERBRIDGE_TOKEN\"\n },\n \"quoteFormat\": \"{MESSAGE} (re @{QUOTENICK}: {QUOTEMESSAGE:.46})\"\n}\n```\n\nThis file should be in Matterdelta's configuration directory, usually `~/.config/matterdelta/`\nin Linux-based systems.\n\nTo get the `accountId` and `chatId` of the chat you want to bridge,\nrun the bot and add its address to your Delta Chat group, then send `/id` in the group,\nthe bot will reply with the account and chat id, then edit the configuration file and restart the bot.\n",
"bugtrack_url": null,
"license": null,
"summary": "Matterbridge API plugin for Delta Chat",
"version": "1.4.0",
"project_urls": {
"Homepage": "https://github.com/deltachat-bot/matterdelta"
},
"split_keywords": [
"deltachat",
" bot",
" matterbridge",
" bridge"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b4ee7aaef73337faa1d3c2597c6c85e339a6115b65062ff8463d6d3ae55eea23",
"md5": "66323fc72b3da7293d7a2a7c9023f2b1",
"sha256": "3d499bbf09038ecf352e4770dbc4500b32d5b45f46769da8bda8be6eb91b1b73"
},
"downloads": -1,
"filename": "matterdelta-1.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "66323fc72b3da7293d7a2a7c9023f2b1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 19339,
"upload_time": "2024-04-27T21:12:11",
"upload_time_iso_8601": "2024-04-27T21:12:11.389058Z",
"url": "https://files.pythonhosted.org/packages/b4/ee/7aaef73337faa1d3c2597c6c85e339a6115b65062ff8463d6d3ae55eea23/matterdelta-1.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1b0a8f0ae26654c4823f7593dc27e562a5808ec775e4abca59fb6dc98e3b29d0",
"md5": "6628721cffda9be4f95c44c0088cfd56",
"sha256": "87cbb57d36feae6558589d9e4f4cb62d48b5cd942c158022cc4f35aa746e84bf"
},
"downloads": -1,
"filename": "matterdelta-1.4.0.tar.gz",
"has_sig": false,
"md5_digest": "6628721cffda9be4f95c44c0088cfd56",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 19193,
"upload_time": "2024-04-27T21:12:12",
"upload_time_iso_8601": "2024-04-27T21:12:12.972741Z",
"url": "https://files.pythonhosted.org/packages/1b/0a/8f0ae26654c4823f7593dc27e562a5808ec775e4abca59fb6dc98e3b29d0/matterdelta-1.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-27 21:12:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "deltachat-bot",
"github_project": "matterdelta",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "matterdelta"
}
