METADATA 2.6 KB

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