jwilk / mwic Goto Github PK

View Code? Open in Web Editor NEW

38.0 4.0 7.0 555 KB

Misspelled Words In Context

Home Page: https://jwilk.net/software/mwic

License: MIT License

Python 83.63% Shell 12.95% Makefile 3.42%

spelling qa

mwic's Introduction

Overview

mwic is a spell-checker that groups possible misspellings and shows them in their contexts. This is useful for checking technical documents, which often contain words that are not included in standard dictionaries.

Example

Prerequisites

The following software is needed to run mwic:

Python ≥ 3.7;
PyEnchant, Python bindings for the Enchant spellchecking system;
regex, alternative regular expression module for Python.

Additionally, the following software is needed to rebuild the manual page from source:

docutils ≥ 0.6.

For pip users:

python3 -m pip install pyenchant regex
python3 -m pip install docutils

For Debian users:

apt-get install python3-enchant python3-regex
apt-get install python3-docutils

mwic's People

Contributors

Stargazers

Watchers

Forkers

dwaynebailey tomviner stweil pombredanne geor-g ykankaya sthagen

mwic's Issues

Makefile doesn't byte-compile Python code

it will create .py files in usr/share/mwic/lib/
that lack the pyo/pyc files and if running as root the imports will
create untracked files in that directory that will remain forever

support NO_COLOR env var

https://no-color.org/

default PAGER pager does not exist

When the PAGER env var is missing, mwic defaults to pager, which is not typically installed, which results in a non-intuitive exception when it is missing.

http://packages.ubuntu.com/search?searchon=contents&keywords=pager&mode=exactfilename&suite=xenial&arch=any
https://packages.debian.org/search?searchon=contents&keywords=pager&mode=path&suite=stable&arch=any
https://admin.fedoraproject.org/pkgdb/packages/?motif=%2Apager

more would be a more sensible default, however a pure python package would be better.

`FAIL: tests/multiword-is-t.exp` on 0.7.5

======================================================================                                                                  
FAIL: tests/multiword-is-t.exp                                                                                                          
----------------------------------------------------------------------                                                                  
Traceback (most recent call last):                                                                                                      
  File "/home/user/pkg/build/mwic/src/mwic-0.7.5/tests/../tests/test_blackbox.py", line 116, in _test                                 
    _test_text(self.path)                                                                                                               
  File "/home/user/pkg/build/mwic/src/mwic-0.7.5/tests/../tests/test_blackbox.py", line 80, in _test_text                             
    assert_multi_line_equal(expected, text)                                                                                             
AssertionError: 'could’t:\n| It could’t ...\n     ^^^^^^^\[433 chars]\n\n' != 'ai’t:\n| It ai’t ...\n     ^^^^\n\ncould’[437 chars]\n\n'

Reproducible builds: manpage includes the build date

Hi Jakub,

Currently, mwic doesn't build reproducible, as the manpage includes the build date. There is a Debian bug which tracks "making the output of rst2man reproducible".

As long as this isn't solved:

Is the date needed inside the manpage?
If so: What about replacing it after building, for example with the date of the last release, taken from the changelog?

Thanks for your work,
cheers,
Georg

Cheers,
Georg