Metadata-Version: 2.0
Name: gabbar
Version: 0.4
Summary: Guarding OSM from invalid or suspicious edits!
Home-page: https://github.com/mapbox/gabbar
Author: Mapbox
Author-email: team@mapbox.com
License: MIT
Keywords: osm
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: click
Requires-Dist: numpy
Requires-Dist: scikit-learn[alldeps]
Requires-Dist: scipy
Provides-Extra: test
Requires-Dist: pandas; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: requests; extra == 'test'
Requires-Dist: twine; extra == 'test'

======
gabbar
======

.. image:: https://img.shields.io/pypi/v/gabbar.svg

**EXPERIMENTAL: UNDER DEVELOPMENT**

Guarding OSM from invalid or suspicious edits, Gabbar is an alpha package of a pre-trained binary problematic/not problematic classifier that was trained on manually labelled changesets from OpenStreetMap.

.. image:: https://cloud.githubusercontent.com/assets/2899501/22643796/0a4a7878-ec86-11e6-9a97-fc63db1caab7.jpg
   :target: https://en.wikipedia.org/wiki/Gabbar_Singh_(character)

https://en.wikipedia.org/wiki/Gabbar_Singh_(character)

Install
=======

.. code-block:: bash

    pip install gabbar


Setup
=====

.. code-block:: bash

    # Setup a virtual environment with Python 3.
    mkvirtualenv --python=$(which python3) gabbar_py3

    # Install in locally editable (``-e``) mode.
    pip install -e .[test]

    # Install node dependencies.
    npm install

Get a prediction
================

.. code-block:: bash

    # Get a prediction for a changeset.
    $ gabbar 47734592
    {"prediction": "good", "timestamp": "2017-04-26 01:05:00.441977", "version": "0.2.4"}



Run tests
=========

.. code-block:: bash

    # Run tests.
    npm run test

Performance
===========

- Performance of the model is tracked in `metrics.csv <./metrics.csv>`_
- Real-world performance is tracked in `performance.md <./docs/performance.md>`_

Hyperlinks
==========

- `Validating and protecting OpenStreetMap <https://www.mapbox.com/blog/validating-osm/>`_
- `Preparing accurate history and caching changesets <https://www.openstreetmap.org/user/geohacker/diary/40846>`_
- `An open database of inconsistent edits observed on OSM from OSMCha <http://www.openstreetmap.org/user/manoharuss/diary/40118>`_


