A Python library to save your settings in a TOML file.
Project description
Simple TOML Settings
A Python library to save your settings in a TOML file.
Development software
Note that this library is still in development and may contain bugs and/or change in the future. Please report any bugs you find on the issue tracker and feel free to make suggestions for improvements.
Installation
You should install this package into a virtual environment. You can use Poetry to do this:
$ poetry add simple-toml-settings
If you don't want to use Poetry, you can use pip from inside your virtual environment:
$ pip install simple-toml-settings
Usage
This is a library to save your settings in a TOML file. It is designed to be simple to use and to be able to save and load settings from a TOML file with a minimal of configuration.
The below is a minimal example, for full documentation and information on available options, see the documentation site.
Usage is simple:
Setup
from simple_toml_settings import TOMLSettings
class MySettings(TOMLSettings):
"""My settings class."""
# Define the settings you want to save
name: str = "My Name"
age: int = 42
favourite_colour: str = "blue"
favourite_number: int = 42
favourite_foods: list = ["pizza", "chocolate", "ice cream"]
settings = MySettings("test_app")
The above will automatically create a TOML file in the user's home directory
called config.toml
, in the subdirectory .test_app/
, and save the settings to
it. If the file already exists, the settings will be loaded from it.
The file contents for the above example would be:
[test_app]
age = 42
favourite_colour = "blue"
favourite_number = 42
name = "My Name"
schema_version = "none"
favourite_foods = ["pizza", "chocolate", "ice cream"]
Using the settings
Once you have created your settings class, you can use it like any other class:
settings = MySettings("test_app")
settings.favourite_colour = "red"
settings.save()
Note that the current library access methods are not set in stone and may change in the future. We will try to keep the changes to a minimum and will provide a migration path (and backwards compatibility) if we do change them.
Development setup
See the Contributing Guidelines for details of how to contribute to this project and set it up for development.
License
This project is released under the terms of the MIT license.
Credits
The original Python boilerplate for this package was created using Pymaker by Grant Ramsay (seapagan) (Me!! 😄).
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for simple_toml_settings-0.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 71f8fb66a73b498a4c9c9b7754b32faa12594bb85780f70b68d7fc0bae80babe |
|
MD5 | 9cd1d1979cbf5b5f94b45f1f27e91ac7 |
|
BLAKE2b-256 | 857dab01f81ece69cdd07d2ae4c81c46f9c853905e0c4c6f4e6ba03a53c459de |
Hashes for simple_toml_settings-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b9f357ccc6978e866e01575ab84d5d885e4ea54d4f103351279a9bce3b842965 |
|
MD5 | a7b04df4375e192f3a3f4ffb81eb5d27 |
|
BLAKE2b-256 | dc9b1689258bb92ea5c067601abcf6bcef4993ecdb4bb6b4781f4e41516cccc9 |