https://github.com/da4089/aioconfig

Dynamic configuration framework for asyncio-based Python services
https://github.com/da4089/aioconfig

asyncio audit-trail config database python python3 runtime-config

Last synced: about 1 month ago
JSON representation

Dynamic configuration framework for asyncio-based Python services

• Host: GitHub
• URL: https://github.com/da4089/aioconfig
• Owner: da4089
• License: mit
• Created: 2019-04-24T02:06:14.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-21T05:26:35.000Z (almost 2 years ago)
• Last Synced: 2024-10-07T19:57:48.811Z (about 1 month ago)
• Topics: asyncio, audit-trail, config, database, python, python3, runtime-config
• Language: Python
• Size: 30.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
aioconfig

=========

This package provides a set of classes that can be used to implement a

configuration and control system for Python server processes.

Features

--------

* Configuration information stored in a tree structure

* Tree root structure standardised

* Running, staged, and saved configurations

  * Runtime changes to running configuration supported

  * Saving running config creates persistent snapshot

  * Revert to saved, or apply staged configuration at runtime

* Pluggable persistence modules

  * Postgres

  * MongoDB

  * Sqlite

  * Files

* Pluggable access modules

  * REST (JSON over HTTPS)

  * telnet

* Access modules use `asyncio`, so module can be added to server code

  with minimal impact

How it Works

------------

Service functionality should be enclosed in a top-level class.  That

class should have accessor methods to configure and manage the service:

getting and setting properties, creating and destroying managed objects.

The main function for the service should create instances of both the

service class, and the Manager class from this package.  The manager's

constructor takes a URL, giving both the scheme and location of the

service's persisted configuration data.

The manager uses that persisted data to configure the service via

its accessor functions.  Using the manager's (optional) access APIs,

the service's configuration and state can be monitored, controlled, and

updated at runtime.

Configuration can be persisted in flat files, Sqlite, PostgreSQL, or

MongoDB.  And access can be via REST or telnet (or both).

A configuration staging area is supported, so that complex changes can

be assembled and checked prior to being applied.  And when the running

configuration is saved, the previous saved configuration is retained,

so the change can be rolled back, and historical comparisons made at any

time.