Metadata-Version: 2.1
Name: revscoring
Version: 2.8.2
Summary: A set of utilities for generating quality scores for MediaWiki revisions
Home-page: https://github.com/wikimedia/revscoring
Author: Aaron Halfaker
Author-email: ahalfaker@wikimedia.org
License: MIT
Description: [![Build Status](https://travis-ci.org/wikimedia/revscoring.svg?branch=master)](https://travis-ci.org/wikimedia/revscoring)
        [![Test coverage](https://codecov.io/gh/wikimedia/revscoring/branch/master/graph/badge.svg)](https://codecov.io/gh/wikimedia/revscoring)
        [![GitHub license](https://img.shields.io/github/license/wikimedia/revscoring.svg)](./LICENSE)
        [![PyPI version](https://badge.fury.io/py/revscoring.svg)](https://badge.fury.io/py/revscoring)
        # Revision Scoring
        
        A generic, machine learning-based revision scoring system designed to help automate critical wiki-work — for example, vandalism detection and removal. This library powers [ORES](https://ores.wikimedia.org).
        
        ## Example
        
        
        Using a scorer_model to score a revision::
        ```python
          import mwapi
          from revscoring import Model
          from revscoring.extractors.api.extractor import Extractor
        
          with open("models/enwiki.damaging.linear_svc.model") as f:
               scorer_model = Model.load(f)
        
          extractor = Extractor(mwapi.Session(host="https://en.wikipedia.org",
                                                  user_agent="revscoring demo"))
        
          feature_values = list(extractor.extract(123456789, scorer_model.features))
        
          print(scorer_model.score(feature_values))
          {'prediction': True, 'probability': {False: 0.4694409344514984, True: 0.5305590655485017}}
          ```
        
        
        # Installation
        
        The easiest way to install is via the Python package installer
        (pip).
        
        ``pip install revscoring``
        
        You may find that some of the dependencies fail to compile (namely
        `scipy`, `numpy` and `sklearn`).  In that case, you'll need to install some
        dependencies in your operating system.
        
        ### Ubuntu & Debian:
          *  Run ``sudo apt-get install python3-dev g++ gfortran liblapack-dev libopenblas-dev``
          *  Run ``sudo apt-get install aspell-ar aspell-bn aspell-el aspell-id aspell-is aspell-pl aspell-ro aspell-sv aspell-ta aspell-uk myspell-cs myspell-de-at myspell-de-ch myspell-de-de myspell-es myspell-et myspell-fa myspell-fr myspell-he myspell-hr myspell-hu myspell-lv myspell-nb myspell-nl myspell-pt-pt myspell-pt-br myspell-ru myspell-hr hunspell-bs hunspell-ca hunspell-en-au hunspell-en-us hunspell-en-gb hunspell-eu hunspell-gl hunspell-it hunspell-hi hunspell-sr hunspell-vi voikko-fi``
        <!-- ### Windows:
        <i>TODO</i>
        -->
        ### MacOS:
          Using Homebrew and pip, installing `revscoring` and `enchant` can be accomplished
          as follows::
        
        ```bash
        brew install aspell --with-all-languages
        brew install enchant
        pip install --no-binary pyenchant revscoring
        ```
        
        #### Adding languages in aspell (MacOS only)
        
        ```bash
        cd /tmp
        wget http://ftp.gnu.org/gnu/aspell/dict/pt/aspell-pt-0.50-2.tar.bz2
        bzip2 -dc aspell-pt-0.50-2.tar.bz2 | tar xvf -
        cd aspell-pt-0.50-2
        ./configure
        make
        sudo make install
        ```
        
         Caveats: <br>
          <b><u> The differences between the `aspell` and `myspell` dictionaries can cause </b>
            <b> <u>some of the tests to fail </b>
        
        
        Finally, in order to make use of language features, you'll need to download
        some NLTK data.  The following command will get the necessary corpora.
        
        ``python -m nltk.downloader omw sentiwordnet stopwords wordnet``
        
        You'll also need to install [enchant](https://en.wikipedia.org/wiki/Enchant_(software))-compatible
        dictionaries of the languages you'd like to use.  We recommend the following:
        
        * languages.arabic: aspell-ar
        * languages.basque: hunspell-eu
        * languages.bengali: aspell-bn
        * languages.bosnian: hunspell-bs
        * languages.catalan: myspell-ca
        * languages.czech: myspell-cs
        * languages.croatian: myspell-hr
        * languages.dutch: myspell-nl
        * languages.english: myspell-en-us myspell-en-gb myspell-en-au
        * languages.estonian: myspell-et
        * languages.finnish: voikko-fi
        * languages.french: myspell-fr
        * languages.galician: hunspell-gl
        * languages.german: myspell-de-at myspell-de-ch myspell-de-de
        * languages.greek: aspell-el
        * languages.hebrew: myspell-he
        * languages.hindi: aspell-hi
        * languages.hungarian: myspell-hu
        * languages.icelandic: aspell-is
        * languages.indonesian: aspell-id
        * languages.italian: myspell-it
        * languages.latvian: myspell-lv
        * languages.norwegian: myspell-nb
        * languages.persian: myspell-fa
        * languages.polish: aspell-pl
        * languages.portuguese: myspell-pt-pt myspell-pt-br
        * languages.serbian: hunspell-sr
        * languages.spanish: myspell-es
        * languages.swedish: aspell-sv
        * languages.tamil: aspell-ta
        * languages.russian: myspell-ru
        * languages.ukrainian: aspell-uk
        * languages.vietnamese: hunspell-vi
        
        # Development
        To contribute, ensure to install the dependencies:
        ```bash
        $ pip install -r requirements.txt
        ```
        
        Install necessary NLTK data:
        
        ``python -m nltk.downloader omw sentiwordnet stopwords wordnet``
        
        ## Running tests
        Make sure you install test dependencies:
        
        ```bash
        $ pip install -r test-requirements.txt
        ```
        
        Then run:
        
        ```bash
        $ pytest . -vv
        ```
        # Reporting bugs
        To report a bug, please use [Phabricator](https://phabricator.wikimedia.org/maniphest/task/edit/form/1/?projects=revscoring)
        
        # Authors
          *   [Aaron Halfaker](http://halfaker.info)
          *   [Helder](https://github.com/he7d3r)
          *   [Adam Roses Wight](https://mediawiki.org/wiki/User:Adamw)
          *   [Amir Sarabadani](https://github.com/Ladsgroup)
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Environment :: Other Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3
Description-Content-Type: text/markdown
