Skip to content

Latest commit

 

History

History
64 lines (45 loc) · 2.6 KB

README.md

File metadata and controls

64 lines (45 loc) · 2.6 KB

Democritus Toml

PyPI CI Lint codecov The Democritus Project uses semver version 2.0.0 The Democritus Project uses black to format code License: LGPL v3

Democritus functions[1] for working with TOML.

[1] Democritus functions are simple, effective, modular, well-tested, and well-documented Python functions.

We use d8s (pronounced "dee-eights") as an abbreviation for democritus (you can read more about this here).

Installation

pip install d8s-toml

Usage

You import the library like:

from d8s_toml import *

Once imported, you can use any of the functions listed below.

Functions

  • def toml_read(toml_data: str):
        """Read the toml data."""
  • def is_toml(possible_toml_data: str) -> bool:
        """Determine whether the possible_toml_data is valid toml data."""
  • def toml_write(data: dict) -> str:
        """Convert the given data to a toml string."""

Development

👋  If you want to get involved in this project, we have some short, helpful guides below:

If you have any questions or there is anything we did not cover, please raise an issue and we'll be happy to help.

Credits

This package was created with Cookiecutter and Floyd Hightower's Python project template.