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.8.tar.gz
(10.3 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
File details
Details for the file simplini-0.0.8.tar.gz.
File metadata
- Download URL: simplini-0.0.8.tar.gz
- Upload date:
- Size: 10.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
067c2d544c5042c9e935ce10748a652f8927d6090db342fc18acacfbfd42ecb2
|
|
| MD5 |
c03c5f1c719d5c8360ca673092d142ee
|
|
| BLAKE2b-256 |
8b64013c9f068c4c960036d15c8224071373a686ccf4281ef6d9e48eed574cc5
|
File details
Details for the file simplini-0.0.8-py3-none-any.whl.
File metadata
- Download URL: simplini-0.0.8-py3-none-any.whl
- Upload date:
- Size: 9.6 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 |
5e4994b93c4f329de7b096e9bd0c1f08e7632b5eaea1c12f92199c9dd3e0feb6
|
|
| MD5 |
6a62774f4e09e84d5bae83e080f7dc47
|
|
| BLAKE2b-256 |
94e8d2f403b9992cd39b1ec73f3b9f64da6fc6af2034f70a7fdde8dc46ef802e
|