[Announce] pydsc

Roman Yakovenko roman.yakovenko at gmail.com
Thu Dec 22 07:46:56 CET 2005


Hi, I would like to announce new module - pydsc.

pydsc is Python documentation spell checker. This modules checks
documentation string
and comments for spelling errors. pydsc uses PyEnchant
(http://pyenchant.sourceforge.net/)
as spell checking engine.

Example of usage:

import pydsc #all modules that will be imported from now will be checked
import readline

More complex example ( taken from pygccxml project ):

import pydsc
#test only pygccxm package for spelling errors
#package_directory defined earlier
pydsc.doc_checker.filter.append( package_directory )
pydsc.doc_checker.filter_type = pydsc.FILTER_TYPE.INCLUDE
#ignore next words
map( pydsc.doc_checker.speller.ignore_always
        , [ 'org', 'http', 'bool', 'str', 'www', 'param' , 'txt',
'decl', 'decls' ] )


pydsc is released under Boost Software License(
http://boost.org/more/license_info.html )

You can download it from here:
http://sourceforge.net/project/showfiles.php?group_id=118209

Pay attention: before installing pydsc you need to install PyEnchant
(http://pyenchant.sourceforge.net/).

Ideas, comments, suggestions or help are welcomed.

Best regards,

Roman Yakovenko



More information about the Python-list mailing list