ConfigHandler
Description
NOTE: Configuration files made by ConfigHandler v0.0.2.1 below are not compatible with ConfigHandler v0.3.0 above.
Create, update, and remove values from a configuration file made by ConfigHandler.
- Simple Mode: Store simple data (e.g., version, program statistics, etc.) in a single file.
- Advanced Mode: Store configuration data using JSON data format. Supports metadata, encryption, and compression.
Installation
- via pip:
pip install py-config-handler - as a Git submodule:
git submodule add https://github.com/Chris1320/ConfigHandler-python.git
Usage
Simple Mode
[QuickStart] Creating a New Configuration File
from config_handler.simple import Simple
config = Simple("config.ini")
# Create a new configuration file by assigning key-value pair.
config.set("foo", "bar") # "foo" is the key, "bar" is the value.
config.set("nums", 123)
config.set("dec", 3.14)
config.set("Aboolean", True)
config.set("unintentional variable!", "unintentional value.")
# Remove values
config.remove("unintentional variable!")
config.save() # Save the data to the file.[QuickStart] Loading an Existing Configuration File
from config_handler.simple import Simple
config = Simple("config.ini")
# Load the data from the file.
config.load()
# Get values from the loaded data.
config.get("foo") # "foo" is the key.
# Change value of a key.
config.set("foo", "barred")
# Add a new key-value pair.
config.set("new_key", "new_value")
# Encode configuration file to Base64.
config.isbase64 = True
# Save changes
config.save()A key can be any string, but must not start with a #, include a =, or include a \n.
A value can by any string, integer, or float.
Advanced Mode
[QuickStart] Creating a New Configuration File
from config_handler.advanced import Advanced
config = Advanced("config.ini")
config.new(
name="Advanced Mode Test",
author="Chris1320",
compression="zlib",
encryption="aes256"
)
# Create a new configuration file by assigning key-value pair.
config.set("foo", "bar") # "foo" is the key, "bar" is the value.
config.set("nums", 123)
config.set("dec", 3.14)
config.set("Aboolean", True)
config.set("unintentional variable!", "unintentional value.")
# Remove values
config.remove("unintentional variable!")
config.save() # Save the data to the file.[QuickStart] Loading an Existing Configuration File
from config_handler.advanced import Advanced
config = Advanced("config.ini")
# Load the data from the file.
config.load()
# Get values from the loaded data.
config.get("foo") # "foo" is the key.
# Change value of a key.
config.set("foo", "barred")
# Add a new key-value pair.
config.set("new_key", "new_value")
# Encode configuration file to Base64.
config.metadata() # Get metadata of the configuration file.
# Save changes
config.save()
