Improve readability, spelling and expression of your text documents
Project description
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.
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
Installation
Extension-Options
web
: include web-apidev
: packages used for development-work around the packagetest
v: all dependencies for the unittests
Locally
This example installs DukeTypem
with web
and dev
extension.
git clone https://github.com/orgua/DukeTypem2D
cd DukeTypem2D
pip install ./[web, test]
Via pip from Pypi
This example installs DukeTypem
with no extension.
pip install DukeTypem2d
Technical Requirements
Basics
- Python with latest
Config
- language: en, de, ..
- feature-choice
- file-ignore
- fix-mode that changes file on-demand (double-spaces)
Input Files
- txt - plain text
- tex - LaTeX
- md - Markdown
- html - HTML
- rst - reStructuredText
Program Structure
Preparation
- file parsing
- cleanup
- remove code
- break text up into file, line, sentence, word
- link line numbers to text-fragments
Rule-Set
- per dataset (all files), file, line, sentence, word
- reimplement TNT
- add in hpmor checks
- Fix basic Syntax of document-format? like markdown
Output
- plain pipeline log (for console)
- HTML, similar to TNT
- Language Server Protocol (LSP) for IDEs
- readability score via Textstat
Inspiration
A modern take on the original Typo Nuke Tool (git).
nearToDo
- allow pre-commit hooking
- add github-actions for testing
- add project-infos
- documentation skeleton
- begin inner workings
- add to pypi
Latest Changes
- project bootstrap based on '23 ruleset
- add configs for tools in toml
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
DukeTypem2D-0.3.1.tar.gz
(43.5 kB
view hashes)
Built Distribution
Close
Hashes for DukeTypem2D-0.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6be4c76dd62e0347900966f2a74b9a6e75987783bf85b914f9594ccbe73cd996 |
|
MD5 | cad3effd09233a33457a5b6916df3563 |
|
BLAKE2b-256 | af54365de36e162166d8215d3ec132d00e76dd502b313126b7fa845a4a95bc45 |