Skip to main content

A simple python real-time remote configuration framework.

Project description


A simple Python lib for manage remote server configuration.

  • Configuration remote unified management center.
  • When the configuration changes, pushed to client in real time.


pip install rtconfig

Server deploy

You can start server directly by single process.

python -m rtconfig.server

Command options:

  • --host: str, server host
  • --port: str, server port
  • --auto-reload: bool, if auto reload
  • --store-type: str, rtconfig server store type
  • --broker-url: str, rtconfig server broker url
  • --login-disable: bool, rtconfig server disable login
  • --config: str, rtconfig server config file path

Client connect

Create a new python module, then write code like this:

from rtconfig import RtConfigClient
client = RtConfigClient('demo',ws_url='ws://',config_module=globals())

So, you can use real time configuration like this:



You can create python config file, And add file path to params

Configuration options:

config name type default description
DEBUG bool false debug mode
MAX_CONNECTION int 1024 max client connections
STORE_TYPE string json_file data store type
BROKER_URL string data store broker url
LOGIN_DISABLED bool false server disable login
OPEN_CLIENT_AUTH_TOKEN bool false data store broker url

Config data store method broker url


BROKER_URL = "~/rtconfig" (默认可不填)


BROKER_URL = "redis://"


BROKER_URL = "mongodb://"


  • rtconfig not support multiprocess deploy now.

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

rtconfig-0.1.8.tar.gz (809.6 kB view hashes)

Uploaded Source

Built Distribution

rtconfig-0.1.8-py3-none-any.whl (874.9 kB view hashes)

Uploaded Python 3

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