https://github.com/python-poetry/tomlkit

Style-preserving TOML library for Python
https://github.com/python-poetry/tomlkit

Last synced: 6 days ago
JSON representation

Style-preserving TOML library for Python

• Host: GitHub
• URL: https://github.com/python-poetry/tomlkit
• Owner: python-poetry
• License: mit
• Created: 2018-07-10T02:21:21.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-10-28T23:31:26.000Z (about 2 months ago)
• Last Synced: 2024-10-29T15:44:42.554Z (about 2 months ago)
• Language: Python
• Size: 956 KB
• Stars: 691
• Watchers: 10
• Forks: 97
• Open Issues: 30
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
[github_release]: https://img.shields.io/github/release/sdispater/tomlkit.svg?logo=github&logoColor=white

[pypi_version]: https://img.shields.io/pypi/v/tomlkit.svg?logo=python&logoColor=white

[python_versions]: https://img.shields.io/pypi/pyversions/tomlkit.svg?logo=python&logoColor=white

[github_license]: https://img.shields.io/github/license/sdispater/tomlkit.svg?logo=github&logoColor=white

[github_action]: https://github.com/sdispater/tomlkit/actions/workflows/tests.yml/badge.svg

[![GitHub Release][github_release]](https://github.com/sdispater/tomlkit/releases/)

[![PyPI Version][pypi_version]](https://pypi.org/project/tomlkit/)

[![Python Versions][python_versions]](https://pypi.org/project/tomlkit/)

[![License][github_license]](https://github.com/sdispater/tomlkit/blob/master/LICENSE)




[![Tests][github_action]](https://github.com/sdispater/tomlkit/actions/workflows/tests.yml)

# TOML Kit - Style-preserving TOML library for Python

TOML Kit is a **1.0.0-compliant** [TOML](https://toml.io/) 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](https://github.com/LeopoldArkham/Molten).

## Usage

See the [documentation](https://tomlkit.readthedocs.io/) for more information.

## Installation

If you are using [Poetry](https://poetry.eustace.io),

add `tomlkit` to your `pyproject.toml` file by using:

```bash

poetry add tomlkit

```

If not, you can use `pip`:

```bash

pip install tomlkit

```

## Running tests

Please clone the repo with submodules with the following command

`git clone --recurse-submodules https://github.com/sdispater/tomlkit.git`.

We need the submodule - `toml-test` for running the tests.

You can run the tests with `poetry run pytest -q tests`