quick-ini 3.2__tar.gz → 4.0__tar.gz

quick_ini-4.0/PKG-INFO

@@ -0,0 +1,126 @@
+Metadata-Version: 2.4
+Name: quick_ini
+Version: 4.0
+Summary: A library for reading from and writing to .ini formatted files
+Author-email: OllieZ-Mods <socksinthewash@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/olliez-mods/Quick-Ini
+Project-URL: Bug Reports, https://github.com/olliez-mods/Quick-Ini/issues
+Project-URL: Source, https://github.com/olliez-mods/Quick-Ini
+Keywords: ini,config,configuration,parser,file
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# QuickINI
+
+A simple and fast INI file parser for Python with support for loading from URLs and automatic type conversion.
+
+## Installation
+
+```bash
+pip install quick_ini
+```
+
+## Quick Start
+
+```python
+from quick_ini import QuickIni
+
+# Load from file
+QuickIni.load_file("config.ini")
+
+# Load from URL
+QuickIni.load_file("https://example.com/config.ini")
+
+# Get values with automatic type conversion
+debug = QuickIni.get_value("debug", False)  # Returns boolean
+port = QuickIni.get_value("port", 8080)     # Returns integer
+
+# Values inside a [section]
+db_port = QuickIni.get_value("port", section="database")  # or get_value("database.port")
+
+# Get everything, or everything in one section
+settings = QuickIni.get_all()
+database = QuickIni.get_all("database")
+
+# Write values back to file
+QuickIni.write_value("new_setting", "value", add_if_not_found=True)
+QuickIni.write_value("port", 5433, section="database")
+```
+
+## Keeping config.ini up to date with a template
+
+Projects often ship a `config.ini.template` that you copy to `config.ini`. When the template gets new settings later, QuickINI can update `config.ini` for you:
+
+```python
+QuickIni.load_file("config.ini", template=True)            # uses config.ini.template
+QuickIni.load_file("config.ini", template="defaults.ini")  # uses defaults.ini
+```
+
+- If `config.ini` doesn't exist, it is created from the template
+- The template decides which settings exist, their order, sections and comments. Your values are kept exactly as you wrote them
+- New settings from the template are added with their default values
+- Settings that are no longer in the template are kept at the end of their section, under a comment
+- The file is only rewritten when something changed, and the previous version is saved as `config.ini.bak`
+- With `template=True` a missing template is skipped, so deployed copies without one still load. A template given by name must exist
+
+```python
+report = QuickIni.get_sync_report()
+if report and report["added"]:
+    print("New settings added to config.ini:", ", ".join(report["added"]))
+```
+
+The report also has `created`, `changed`, `orphaned` (settings kept that aren't in the template) and `backup`. Use `QuickIni.sync_template("config.ini")` to sync without loading.
+
+## File Format
+
+```ini
+# Comments start with #
+debug = yes          # comments can also go after a value
+port = 8080
+timeout = 2.5e1
+color = \#fff        # use \# to put a # in a value
+
+# Lists
+parts =
+|one
+|two
+
+[database]
+host = localhost
+port = 5432
+```
+
+## Features
+
+- Load INI files from local filesystem or URLs
+- Automatic type conversion: int, float (including `-1.5` and `1e5`), bool (`true`/`false`, `yes`/`no`, `on`/`off`) and str
+- Sections, plus `#` comments, including after a value (escape `#` as `\#` in values)
+- Lists using `|` lines
+- Keep `config.ini` up to date with a template file
+- Write values back to files safely, the file is never left half written
+- Error handling with detailed messages
+- Static class design for easy use across modules
+
+## Examples
+
+Runnable examples are in the [examples](examples) folder:
+
+- [basic](examples/basic/basic.py): loading a file, defaults, types and lists
+- [sections](examples/sections/sections.py): reading keys in `[sections]` and `get_all()`
+- [writing](examples/writing/writing.py): changing and adding values
+- [template_sync](examples/template_sync/template_sync.py): creating and updating `config.ini` from `config.ini.template`
+
+Run one with `python examples/basic/basic.py` after installing QuickINI.

quick_ini-4.0/README.md

@@ -0,0 +1,101 @@
+# QuickINI
+
+A simple and fast INI file parser for Python with support for loading from URLs and automatic type conversion.
+
+## Installation
+
+```bash
+pip install quick_ini
+```
+
+## Quick Start
+
+```python
+from quick_ini import QuickIni
+
+# Load from file
+QuickIni.load_file("config.ini")
+
+# Load from URL
+QuickIni.load_file("https://example.com/config.ini")
+
+# Get values with automatic type conversion
+debug = QuickIni.get_value("debug", False)  # Returns boolean
+port = QuickIni.get_value("port", 8080)     # Returns integer
+
+# Values inside a [section]
+db_port = QuickIni.get_value("port", section="database")  # or get_value("database.port")
+
+# Get everything, or everything in one section
+settings = QuickIni.get_all()
+database = QuickIni.get_all("database")
+
+# Write values back to file
+QuickIni.write_value("new_setting", "value", add_if_not_found=True)
+QuickIni.write_value("port", 5433, section="database")
+```
+
+## Keeping config.ini up to date with a template
+
+Projects often ship a `config.ini.template` that you copy to `config.ini`. When the template gets new settings later, QuickINI can update `config.ini` for you:
+
+```python
+QuickIni.load_file("config.ini", template=True)            # uses config.ini.template
+QuickIni.load_file("config.ini", template="defaults.ini")  # uses defaults.ini
+```
+
+- If `config.ini` doesn't exist, it is created from the template
+- The template decides which settings exist, their order, sections and comments. Your values are kept exactly as you wrote them
+- New settings from the template are added with their default values
+- Settings that are no longer in the template are kept at the end of their section, under a comment
+- The file is only rewritten when something changed, and the previous version is saved as `config.ini.bak`
+- With `template=True` a missing template is skipped, so deployed copies without one still load. A template given by name must exist
+
+```python
+report = QuickIni.get_sync_report()
+if report and report["added"]:
+    print("New settings added to config.ini:", ", ".join(report["added"]))
+```
+
+The report also has `created`, `changed`, `orphaned` (settings kept that aren't in the template) and `backup`. Use `QuickIni.sync_template("config.ini")` to sync without loading.
+
+## File Format
+
+```ini
+# Comments start with #
+debug = yes          # comments can also go after a value
+port = 8080
+timeout = 2.5e1
+color = \#fff        # use \# to put a # in a value
+
+# Lists
+parts =
+|one
+|two
+
+[database]
+host = localhost
+port = 5432
+```
+
+## Features
+
+- Load INI files from local filesystem or URLs
+- Automatic type conversion: int, float (including `-1.5` and `1e5`), bool (`true`/`false`, `yes`/`no`, `on`/`off`) and str
+- Sections, plus `#` comments, including after a value (escape `#` as `\#` in values)
+- Lists using `|` lines
+- Keep `config.ini` up to date with a template file
+- Write values back to files safely, the file is never left half written
+- Error handling with detailed messages
+- Static class design for easy use across modules
+
+## Examples
+
+Runnable examples are in the [examples](examples) folder:
+
+- [basic](examples/basic/basic.py): loading a file, defaults, types and lists
+- [sections](examples/sections/sections.py): reading keys in `[sections]` and `get_all()`
+- [writing](examples/writing/writing.py): changing and adding values
+- [template_sync](examples/template_sync/template_sync.py): creating and updating `config.ini` from `config.ini.template`
+
+Run one with `python examples/basic/basic.py` after installing QuickINI.

quick_ini-4.0/pyproject.toml

@@ -0,0 +1,37 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "quick_ini"
+version = "4.0"
+description = "A library for reading from and writing to .ini formatted files"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "OllieZ-Mods", email = "socksinthewash@gmail.com" }]
+requires-python = ">=3.10"
+keywords = ["ini", "config", "configuration", "parser", "file"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Typing :: Typed",
+]
+
+[project.urls]
+Homepage = "https://github.com/olliez-mods/Quick-Ini"
+"Bug Reports" = "https://github.com/olliez-mods/Quick-Ini/issues"
+Source = "https://github.com/olliez-mods/Quick-Ini"
+
+[tool.setuptools]
+packages = ["quick_ini"]
+
+[tool.setuptools.package-data]
+quick_ini = ["py.typed"]