toml-fmt-common

1.3.2 · active · verified Mon Apr 13

toml-fmt-common is an internal utility library providing common logic for TOML formatters within the `toml-fmt` project, such as `pyproject-fmt` and `tox-toml-fmt`. While a PyPI package exists (current version 1.3.2), its primary purpose is as a dependency for other tools, not for direct end-user interaction. The development of its code has moved into the `tox-dev/toml-fmt` monorepo, where it is actively maintained as part of a larger ecosystem with frequent releases for its consuming projects.

Warnings

gotcha This library is explicitly noted as 'meant to only be used by that project' (referring to the toml-fmt umbrella). Direct import and usage by end-users is not recommended and may lead to unexpected behavior or API instability, as its internal structure can change without warning.
Fix: Instead of `toml-fmt-common`, use higher-level tools like `pyproject-fmt` or `tox-toml-fmt` which are designed for user interaction.
deprecated The standalone `tox-dev/toml-fmt-common` GitHub repository is deprecated. Its code and development have been migrated into the `tox-dev/toml-fmt` monorepo. While the PyPI package `toml-fmt-common` still exists and is updated, active development happens within the monorepo structure.
Fix: For the latest source code and development, refer to `https://github.com/tox-dev/toml-fmt/tree/main/toml-fmt-common`.
gotcha Past issues have included panics when encountering non-array nodes in array operations and unintended write checks in `--check` and `--stdout` modes. While fixes have been applied, this highlights the potential for internal logic quirks if directly interacting with the library's components outside of its intended `toml-fmt` ecosystem.
Fix: Ensure you are using the latest versions of `pyproject-fmt` or `tox-toml-fmt` to benefit from these internal fixes. Avoid direct manipulation of `toml-fmt-common`'s internals.

Install

pip install toml-fmt-common Install PyPI package

Quickstart

This library is intended for internal use by other `toml-fmt` projects (e.g., `pyproject-fmt`, `tox-toml-fmt`) and does not provide a public API for direct consumption by end-users. Attempting to use it directly may result in unstable or undocumented behavior.

# toml-fmt-common is primarily an internal library and not designed for direct end-user import or standalone quickstart usage.

view raw JSON →