METADATA 2.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. Metadata-Version: 2.4
  2. Name: tomlkit
  3. Version: 0.14.0
  4. Summary: Style preserving TOML library
  5. License: MIT
  6. License-File: LICENSE
  7. Author: Sébastien Eustace
  8. Author-email: sebastien@eustace.io
  9. Requires-Python: >=3.9
  10. Classifier: License :: OSI Approved :: MIT License
  11. Classifier: Programming Language :: Python :: 3
  12. Classifier: Programming Language :: Python :: 3.9
  13. Classifier: Programming Language :: Python :: 3.10
  14. Classifier: Programming Language :: Python :: 3.11
  15. Classifier: Programming Language :: Python :: 3.12
  16. Classifier: Programming Language :: Python :: 3.13
  17. Classifier: Programming Language :: Python :: 3.14
  18. Project-URL: Homepage, https://github.com/sdispater/tomlkit
  19. Project-URL: Repository, https://github.com/sdispater/tomlkit
  20. Description-Content-Type: text/markdown
  21. [github_release]: https://img.shields.io/github/release/sdispater/tomlkit.svg?logo=github&logoColor=white
  22. [pypi_version]: https://img.shields.io/pypi/v/tomlkit.svg?logo=python&logoColor=white
  23. [python_versions]: https://img.shields.io/pypi/pyversions/tomlkit.svg?logo=python&logoColor=white
  24. [github_license]: https://img.shields.io/github/license/sdispater/tomlkit.svg?logo=github&logoColor=white
  25. [github_action]: https://github.com/sdispater/tomlkit/actions/workflows/tests.yml/badge.svg
  26. [![GitHub Release][github_release]](https://github.com/sdispater/tomlkit/releases/)
  27. [![PyPI Version][pypi_version]](https://pypi.org/project/tomlkit/)
  28. [![Python Versions][python_versions]](https://pypi.org/project/tomlkit/)
  29. [![License][github_license]](https://github.com/sdispater/tomlkit/blob/master/LICENSE)
  30. <br>
  31. [![Tests][github_action]](https://github.com/sdispater/tomlkit/actions/workflows/tests.yml)
  32. # TOML Kit - Style-preserving TOML library for Python
  33. TOML Kit is a **1.0.0-compliant** [TOML](https://toml.io/) library.
  34. It includes a parser that preserves all comments, indentations, whitespace and internal element ordering,
  35. and makes them accessible and editable via an intuitive API.
  36. You can also create new TOML documents from scratch using the provided helpers.
  37. Part of the implementation has been adapted, improved and fixed from [Molten](https://github.com/LeopoldArkham/Molten).
  38. ## Usage
  39. See the [documentation](https://tomlkit.readthedocs.io/) for more information.
  40. ## Installation
  41. If you are using [Poetry](https://poetry.eustace.io),
  42. add `tomlkit` to your `pyproject.toml` file by using:
  43. ```bash
  44. poetry add tomlkit
  45. ```
  46. If not, you can use `pip`:
  47. ```bash
  48. pip install tomlkit
  49. ```
  50. ## Running tests
  51. Please clone the repo with submodules with the following command:
  52. ```bash
  53. git clone --recurse-submodules https://github.com/python-poetry/tomlkit.git
  54. ```
  55. The `toml-test` submodule is required for running the tests.
  56. You can then run the tests with
  57. ```bash
  58. poetry run pytest -q tests
  59. ```