webxdcbot


Namewebxdcbot JSON
Version 0.1.0 PyPI version JSON
download
home_page
SummaryExample Delta Chat bot + webxdc app
upload_time2023-10-16 23:00:14
maintainer
docs_urlNone
author
requires_python>=3.8
license
keywords deltachat bot
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # webxdcbot

Example Delta Chat bot + webxdc app as bot's frontend.

## Install

Clone this repository and run inside the project's folder:

```sh
# first build the webxdc app / frontend:
cd frontend/
npm install
npm run build
cd ..
# install the python package bot / backend:
pip install .
```

### Installing deltachat-rpc-server

This program depends on a standalone Delta Chat RPC server `deltachat-rpc-server` program that must be
available in your `PATH`. To install it check:
https://github.com/deltachat/deltachat-core-rust/tree/master/deltachat-rpc-server

## Configuration

Configure the bot:

```sh
webxdcbot init bot@example.com PASSWORD
```

Start the bot:

```sh
webxdcbot serve
```

Run `webxdcbot --help` to see all available options.

## Usage

1. Write to the bot in Delta Chat, for example send a "hi" message to it
2. The bot will reply with the webxdc app
3. Open the webxdc app and send a message there
4. The bot will reply to you inside the app

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "webxdcbot",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "deltachat,bot",
    "author": "",
    "author_email": "adbenitez <adbenitez@hispanilandia.net>",
    "download_url": "",
    "platform": null,
    "description": "# webxdcbot\n\nExample Delta Chat bot + webxdc app as bot's frontend.\n\n## Install\n\nClone this repository and run inside the project's folder:\n\n```sh\n# first build the webxdc app / frontend:\ncd frontend/\nnpm install\nnpm run build\ncd ..\n# install the python package bot / backend:\npip install .\n```\n\n### Installing deltachat-rpc-server\n\nThis program depends on a standalone Delta Chat RPC server `deltachat-rpc-server` program that must be\navailable in your `PATH`. To install it check:\nhttps://github.com/deltachat/deltachat-core-rust/tree/master/deltachat-rpc-server\n\n## Configuration\n\nConfigure the bot:\n\n```sh\nwebxdcbot init bot@example.com PASSWORD\n```\n\nStart the bot:\n\n```sh\nwebxdcbot serve\n```\n\nRun `webxdcbot --help` to see all available options.\n\n## Usage\n\n1. Write to the bot in Delta Chat, for example send a \"hi\" message to it\n2. The bot will reply with the webxdc app\n3. Open the webxdc app and send a message there\n4. The bot will reply to you inside the app\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Example Delta Chat bot + webxdc app",
    "version": "0.1.0",
    "project_urls": null,
    "split_keywords": [
        "deltachat",
        "bot"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f2f8d87aa13bc5b8b7e801a7ee0e6724ee23befba8462ae5698540f233fb256c",
                "md5": "865cb4f92fd5eb52e0bde0b3e2e59557",
                "sha256": "75f45fbe468d99d9995569c40968f336c00e9fcf13c8b7ea8384b6279c748a44"
            },
            "downloads": -1,
            "filename": "webxdcbot-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "865cb4f92fd5eb52e0bde0b3e2e59557",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 5848,
            "upload_time": "2023-10-16T23:00:14",
            "upload_time_iso_8601": "2023-10-16T23:00:14.216933Z",
            "url": "https://files.pythonhosted.org/packages/f2/f8/d87aa13bc5b8b7e801a7ee0e6724ee23befba8462ae5698540f233fb256c/webxdcbot-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-16 23:00:14",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "webxdcbot"
}
        
Elapsed time: 0.12748s