Skip to main content

Zulip's Flask server for running bots

Project description

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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zulip_botserver-0.9.0.tar.gz (8.6 kB view details)

Uploaded Source

Built Distribution

zulip_botserver-0.9.0-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

Details for the file zulip_botserver-0.9.0.tar.gz.

File metadata

  • Download URL: zulip_botserver-0.9.0.tar.gz
  • Upload date:
  • Size: 8.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for zulip_botserver-0.9.0.tar.gz
Algorithm Hash digest
SHA256 af532e5b0e98018a9716224bb1b7e4aa90fb0734522a8828d9cb45de50ec46a5
MD5 9063ff5f84ebb8a1fcf328057cd383a8
BLAKE2b-256 0de297fa4bb1e1fb514ac0fe66952b7384b368943678fad11fa08651c982c161

See more details on using hashes here.

File details

Details for the file zulip_botserver-0.9.0-py3-none-any.whl.

File metadata

File hashes

Hashes for zulip_botserver-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1a5b332b46d4d6172c665acf45f1bcb4f1e17246c6034df8879418141b27a2fd
MD5 1a1d793a727162f1f65578ed38d1ac44
BLAKE2b-256 7b3ae9be5bb630152e689934536f56e93e92cfd361cccac957fd372af28ea786

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page