DukeTypem2D 0.3.2

Improve readability, spelling and expression of your text documents

Duke Typem 2D

Improves readability, spelling and expression of your text documents. The main focus will be scientific documents.

WARNING: as of now this is a non-working skeleton / prototype.

Future Documentation

Current Documentation WIP

Planned features:

• read in your documents (tex, markdown, reStructuredText, word, pdf, ...)
• check spelling
• hint at common mistakes
• evaluate choice of words
• improve readability and overall quality
• analyze phrasing and expression

How can it be used?

• python package
• continuous integration via pre-commit
• web-API
• maybe a Language Server Protocol (LSP)

Inspiration

A modern take on the original Typo Nuke Tool (git).

Naming

• duketypem -> CLI
• DukeTypem2D -> PyPI, python-package-import (TODO: check)
• .DukeTypem2D.yaml -> config-file (YAML or TOML excepted)
• [tool.DukeTypem2D] -> entry in pyproject.toml

Near Future ToDo

• begin inner workings
• enable documentation when public (link in conf.py)
• run pytest with coverage (and create tests)

Latest Changes

• project bootstrap based on '23 ruleset

• add configs for tools in toml

• add github-actions for testing

• add action for pypi-publish (with secret api-token)

• add project-meta-badges

• add to pypi

• documentation skeleton

• allow pre-commit hooking

• add doc for additional resources

• config-loader (implement, document, unittest)