TOML Kit - Style-preserving TOML library for Python
TOML Kit is a 1.1.0-compliant TOML library.
It includes a parser that preserves all comments, indentations, whitespace and internal element ordering, and makes them accessible and editable via an intuitive API.
You can also create new TOML documents from scratch using the provided helpers.
Part of the implementation has been adapted, improved and fixed from Molten.
Usage
See the documentation for more information.
Limitations
tomlkit preserves the original layout of a document, with one exception: a
sub-table that extends an array of tables out of order — for example a
[fruit.apple.texture] header that appears after [[fruit]] with an unrelated
table in between — is normalized into the array's last element when the document
is re-serialized, rather than kept at its original position. The data is
preserved; only the physical placement of that sub-table changes.
Installation
If you are using uv, you can
add tomlkit to your pyproject.toml file by using:
uv add tomlkit
Or just:
uv pip install tomlkit
If not, you can use pip:
pip install tomlkit
Running tests
Please clone the repo with submodules with the following command:
git clone --recurse-submodules https://github.com/python-poetry/tomlkit.git
The toml-test submodule is required for running the tests.
You can then run the tests with
poetry run pytest -q tests
1 maintainer
Release files for tomlkit 0.15.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| tomlkit-0.15.1.tar.gz | 180.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| tomlkit-0.15.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 229.6 kB
Release files / tomlkit-0.15.1.tar.gz
| Download URL | tomlkit-0.15.1.tar.gz |
|---|---|
| Size | 180.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e25bbf38843005246210a12982776f27f99cb9be67160e14434d0c0d21ee1e97
|
|
BLAKE2b-256 checksum How to use checksums |
9496e07752635b98536177fa1f37671c8f3cdde2e724c6bcf6034b2cfb571565
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.4.1 CPython/3.12.3 Linux/6.17.0-1020-azure
|
Release files / tomlkit-0.15.1-py3-none-any.whl
| Download URL | tomlkit-0.15.1-py3-none-any.whl |
|---|---|
| Size | 49.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
177a05aece5a8ca5266fd3c448abb47b8d352f09d477d3ca8332db4d89b24304
|
|
BLAKE2b-256 checksum How to use checksums |
13bc8c13eb66537dce1d2bd3a57132902f38d0e7f5bb46fa9f4daed9fe9d76ee
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.4.1 CPython/3.12.3 Linux/6.17.0-1020-azure
|
