Skip to main content

Python multilingual application for inclusive writing

Project description

inclusivewriting

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 inclusive.main en

Running inclusivewriting

Here, en corresponds to the English language.

It is also possible to specify a file.

python3 -m inclusivewriting.main 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

inclusivewriting-0.8.tar.gz (22.7 kB view details)

Uploaded Source

Built Distribution

inclusivewriting-0.8-py3-none-any.whl (33.9 kB view details)

Uploaded Python 3

File details

Details for the file inclusivewriting-0.8.tar.gz.

File metadata

  • Download URL: inclusivewriting-0.8.tar.gz
  • Upload date:
  • Size: 22.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.10

File hashes

Hashes for inclusivewriting-0.8.tar.gz
Algorithm Hash digest
SHA256 22153522e48796dcca6a72cacfac5fc7c751ee570155019947cc776457b42601
MD5 8eefb1f6893c947febc38fa85dda1535
BLAKE2b-256 2025e4de73d0826437f6446d9023a4994588339b9a7dec0d89c06c75779eab99

See more details on using hashes here.

File details

Details for the file inclusivewriting-0.8-py3-none-any.whl.

File metadata

  • Download URL: inclusivewriting-0.8-py3-none-any.whl
  • Upload date:
  • Size: 33.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.10

File hashes

Hashes for inclusivewriting-0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 ab07b6c1d87254154dd04e28e2daf574eb944f2687a7cde111fa92b98617e431
MD5 9cbfb36404e19790b252e1e7edfcdb22
BLAKE2b-256 c720b9626152e7ac2e8ead1fab33cb53cd366b160b18df6648ca743290457a82

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page