Metadata-Version: 2.4
Name: zulip_botserver
Version: 0.9.1
Summary: Zulip's Flask server for running bots
Home-page: https://www.zulip.org/
Author: Zulip Open Source Project
Author-email: zulip-devel@googlegroups.com
Project-URL: Source, https://github.com/zulip/python-zulip-api/
Project-URL: Documentation, https://zulip.com/api
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Topic :: Communications :: Chat
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: zulip
Requires-Dist: zulip_bots
Requires-Dist: flask>=0.12.2
Requires-Dist: typing_extensions>=4.5.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

```
zulip-botserver --config-file <path to botserverrc> --hostname <address> --port <port>
```

Example: `zulip-botserver --config-file ~/botserverrc`

This program loads the bot configurations from the
config file (`botserverrc`, here) and loads the bot modules.
It then starts the server and fetches the requests to the
above loaded modules and returns the success/failure result.

The `--hostname` and `--port` arguments are optional, and default to
127.0.0.1 and 5002 respectively.

The format for a configuration file is:

    [helloworld]
    key=value
    email=helloworld-bot@zulip.com
    site=http://localhost
    token=abcd1234
    bot-config-file=helloworld.conf

Is passed `--use-env-vars` instead of `--config-file`, the
configuration can instead be provided via the `ZULIP_BOTSERVER_CONFIG`
environment variable.  This should be a JSON-formatted dictionary of
bot names to dictionary of their configuration; for example:

    ZULIP_BOTSERVER_CONFIG='{"helloworld":{"email":"helloworld-bot@zulip.com","key":"value","site":"http://localhost","token":"abcd1234"}}' \
      zulip-botserver --use-env-vars
