# {py:mod}`tdk.tools`

```{py:module} tdk.tools
```

```{autodoc2-docstring} tdk.tools
:allowtitles:
```

## Module Contents

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`hecele <tdk.tools.hecele>`
  - ```{autodoc2-docstring} tdk.tools.hecele
    :summary:
    ```
* - {py:obj}`get_syllable_type <tdk.tools.get_syllable_type>`
  - ```{autodoc2-docstring} tdk.tools.get_syllable_type
    :summary:
    ```
* - {py:obj}`get_letter_type <tdk.tools.get_letter_type>`
  - ```{autodoc2-docstring} tdk.tools.get_letter_type
    :summary:
    ```
* - {py:obj}`lowercase <tdk.tools.lowercase>`
  - ```{autodoc2-docstring} tdk.tools.lowercase
    :summary:
    ```
* - {py:obj}`dictionary_order <tdk.tools.dictionary_order>`
  - ```{autodoc2-docstring} tdk.tools.dictionary_order
    :summary:
    ```
* - {py:obj}`counter <tdk.tools.counter>`
  - ```{autodoc2-docstring} tdk.tools.counter
    :summary:
    ```
* - {py:obj}`streaks <tdk.tools.streaks>`
  - ```{autodoc2-docstring} tdk.tools.streaks
    :summary:
    ```
* - {py:obj}`max_streak <tdk.tools.max_streak>`
  - ```{autodoc2-docstring} tdk.tools.max_streak
    :summary:
    ```
* - {py:obj}`distinct <tdk.tools.distinct>`
  - ```{autodoc2-docstring} tdk.tools.distinct
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`__all__ <tdk.tools.__all__>`
  - ```{autodoc2-docstring} tdk.tools.__all__
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: tdk.tools.__all__
:value: >
   ['hecele', 'get_syllable_type', 'get_letter_type', 'lowercase', 'dictionary_order', 'counter', 'stre...

```{autodoc2-docstring} tdk.tools.__all__
```

````

````{py:function} hecele(text: str, /) -> list[str]
:canonical: tdk.tools.hecele

```{autodoc2-docstring} tdk.tools.hecele
```
````

````{py:function} get_syllable_type(syllable: str, /) -> tdk.enums.SyllableType
:canonical: tdk.tools.get_syllable_type

```{autodoc2-docstring} tdk.tools.get_syllable_type
```
````

````{py:function} get_letter_type(letter: str, /) -> tdk.enums.LetterType
:canonical: tdk.tools.get_letter_type

```{autodoc2-docstring} tdk.tools.get_letter_type
```
````

````{py:function} lowercase(text: str, /, *, keep_nonletters: bool = False, remove_hats: bool = True) -> str
:canonical: tdk.tools.lowercase

```{autodoc2-docstring} tdk.tools.lowercase
```
````

````{py:function} dictionary_order(word: str, /) -> tuple[int, ...]
:canonical: tdk.tools.dictionary_order

```{autodoc2-docstring} tdk.tools.dictionary_order
```
````

````{py:function} counter(word: str, *, targets: str = VOWELS) -> int
:canonical: tdk.tools.counter

```{autodoc2-docstring} tdk.tools.counter
```
````

````{py:function} streaks(text: str, /, *, targets: str = CONSONANTS) -> list[int]
:canonical: tdk.tools.streaks

```{autodoc2-docstring} tdk.tools.streaks
```
````

````{py:function} max_streak(word: str, *, targets: str = CONSONANTS) -> int
:canonical: tdk.tools.max_streak

```{autodoc2-docstring} tdk.tools.max_streak
```
````

````{py:function} distinct(seq: collections.abc.Sequence[T]) -> collections.abc.Sequence[T]
:canonical: tdk.tools.distinct

```{autodoc2-docstring} tdk.tools.distinct
```
````