Skip to content

johnsamuelwrites/inclusive

Repository files navigation

inclusivewriting

Python package Pylint CodeQL

inclusivewriting is a multilingual application for inclusive writing. Languages evolve. Developed in Python, this application helps to write texts in an inclusive way. The application detects possibly problematic phrases and suggests some replacements.

The application is configurable and it permits the users to add

  • support for new languages
  • add new suggestions to existing languages
  • update suggestions

Usage

To use inclusivewriting, specify the language and enter a text

python -m inclusivewriting en

Running inclusivewriting

Here, en corresponds to the English language.

It is also possible to specify a file.

python3 -m inclusivewriting en --filepath filepath

Installation

pip install inclusivewriting

Resources

Resources: Resources and references to sources in different languages

Contribute

There are three ways to contribute:

  • Add a missing language in resources folder and add it to configuration.json.
  • Update existing lists of already existing languages. For example, in English.
  • Translate inclusivewriting. Check existing or add new locales.

A detailed desciption is present here.

Test cases and coverage

All the test cases can be run in the following manner

$ python3 -m tests.tests

Code coverage report can also be generated by running the unit tests using the coverage tool.

$ coverage run --source=inclusivewriting -m unittest tests.tests
$ coverage report -m

Author

  • John Samuel

Licence

All code are released under GPLv3+ licence. The associated documentation and other content are released under CC-BY-SA.