A simple INI file parser/writer
Project description
A simple INI file parser and writer for Python that works.
Installation
pip install simplini
Why?
The reasons this library was created:
- Standard library configparser does not support round trip editing (comments will not be written back), see https://docs.python.org/3/library/configparser.html
- Alternatives like https://github.com/DiffSK/configobj have a lot of bugs and are not actively maintained
Comparison
| Library | Round-trip editing | Maintenance | Correctness | Configurability | Multi-line values | Error reporting |
|---|---|---|---|---|---|---|
configparser |
❌ | 🟢 | ✅ | ✅ | ✅ | 🙂 |
ConfigObj |
✅ | 🔴 | 🐛 | ❌ | ❌ | 🤔 |
python-ini |
❌ | ❓ | ❓ | ✅ | ❓ | 🙁 |
ini-parser |
✅ | ❓ | 🐛 | ❌ | ❌ | 🙁 |
simplini |
✅ | 🟢 | ✅ | ✅ | ✅ | 🥰 |
Features
- Simple API
- Round-trip editing preserving comments
- Non-ambiguous strings encoding
- Configurable parsing and rendering behavior
- No surprises like sudden interpolation or lower-casing option names
Usage
Basic usage example:
from simplini import IniConfig
# Create a new INI config
config = IniConfig()
# Add values to the default section
config.unnamed_section.set("app_name", "My App")
config.unnamed_section.set("version", "1.0.0")
# Add a comment to the default section
config.unnamed_section.comment = ["Configuration for My App", "Created on 2025-09-28"]
# Save to file
config.save("config.ini")
# Load from file
loaded_config = IniConfig.load("config.ini")
app_name = loaded_config.unnamed_section["app_name"].value # "My App"
Example config file output:
# Configuration for My App
# Created on 2025-09-28
app_name = "My App"
version = "1.0.0"
License
MIT License
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
simplini-0.0.14.tar.gz
(11.6 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
simplini-0.0.14-py3-none-any.whl
(11.1 kB
view details)
File details
Details for the file simplini-0.0.14.tar.gz.
File metadata
- Download URL: simplini-0.0.14.tar.gz
- Upload date:
- Size: 11.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a784c66afc25a26289b11e59e8f1009a731be4633f4e0e70236c0385de6904ed
|
|
| MD5 |
60ce7e9963fd9812c2d9829135f4834d
|
|
| BLAKE2b-256 |
b293954396d4bebe41f6767839443a86f7c61dc81e65f11c9bd6c815306ddb89
|
File details
Details for the file simplini-0.0.14-py3-none-any.whl.
File metadata
- Download URL: simplini-0.0.14-py3-none-any.whl
- Upload date:
- Size: 11.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
337d73d67396b2971eeb3ecb717593fe4fcf782a1fcbc3c427838f7d43b4b7aa
|
|
| MD5 |
c00802f14154eff36b5bd64549fa6795
|
|
| BLAKE2b-256 |
c3b646ac012e65e17bb03a4737b5dbe4498e91ee182bf0a7065e1d1bc55b7da1
|