GithubHelp home page GithubHelp logo

johnsamuelwrites / inclusive Goto Github PK

View Code? Open in Web Editor NEW
4.0 2.0 0.0 98 KB

A Python multilingual application for inclusive writing

License: GNU General Public License v3.0

Python 100.00%
inclusive-language multilingual language inclusive-design inclusive-terminologies inclusive

inclusive's Introduction

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 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.

inclusive's People

Contributors

johnsamuelwrites avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

inclusive's Issues

Support for docstrings

I'm considering using a tool similar to this, but I would need it to work to automatically scan docstrings... maybe something that works in tandem with PyDocStyle? I'm not quite sure

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.