Skip to main content

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.

Metadata

Release files for inclusivewriting 0.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for inclusivewriting 0.8
File Size Uploaded
inclusivewriting-0.8.tar.gz 22.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for inclusivewriting 0.8
File Interpreter ABI Platform
inclusivewriting-0.8-py3-none-any.whl Python 3 none any Details

Total release size: 56.6 kB

Release files / inclusivewriting-0.8.tar.gz

Download URL inclusivewriting-0.8.tar.gz
Size 22.7 kB
Tags Source
SHA-256 checksum
How to use checksums
22153522e48796dcca6a72cacfac5fc7c751ee570155019947cc776457b42601
BLAKE2b-256 checksum
How to use checksums
2025e4de73d0826437f6446d9023a4994588339b9a7dec0d89c06c75779eab99
Upload date
Uploaded using Trusted Publishing?
What is 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

Release files / inclusivewriting-0.8-py3-none-any.whl

Download URL inclusivewriting-0.8-py3-none-any.whl
Size 33.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ab07b6c1d87254154dd04e28e2daf574eb944f2687a7cde111fa92b98617e431
BLAKE2b-256 checksum
How to use checksums
c720b9626152e7ac2e8ead1fab33cb53cd366b160b18df6648ca743290457a82
Upload date
Uploaded using Trusted Publishing?
What is 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

Release history Release notifications | RSS feed

This release

0.8 This release

2 release files

0.7

2 release files

0.6

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page