<commit_before>OpenStreetMap Hall Monitor
==========================

This module is a passive changeset monitoring tool for use with OpenStreetMap. It's still under construction as I am moving from v0 (a beta site that was mixed with other tools) to v1 (a standalone data processor).

Features that will eventually be available to look for:

* Large numbers of edits in a changeset, or a large proportion of modifications/deletions (with the option to use a whitelist)
* Edits that range across long distances
* Edits to certain tags
* Edits by watched users
* Edits to watched objects
* Edits with certain keywords
* Edits in a certain area
* Objects that have a very similar structure of a list of objects commonly drawn for vandalism (you know what we're talking about)
* Notification of edits matching the above criteria
* Other ideas


Requirements
------------

[OpenStreetMap Diff Tool](http://www.github.com/ethan-nelson/osm_diff_tool) is required. If you use the setup.py file, it should fetch the repository from pypi. Also, psycopg2 is necessary at the moment for all the database work.

Use
---

To begin use, simply call `import osmhm` after installation.

Sample calls available for now:

```
import osmhm

osmhm.run(history=False) #Searches for vandalism without logging every single changeset
```

More information will be coming soon and the tool will continue to be improved, including the option to remove the dependency on psycopg2 and a postgres database to store everything.
<commit_msg>README updated with status and call<commit_after>OpenStreetMap Hall Monitor
==========================

This module is a passive changeset monitoring tool for use with OpenStreetMap. It's still under construction as I am moving from v0 (a beta site that was mixed with other tools) to v1 (a standalone data processor).

Features that will eventually be available to look for:

* ~~Large numbers of edits in a changeset, or a large proportion of modifications/deletions (with the option to use a whitelist)~~ (mostly)
* Edits that range across long distances
* Edits to certain tags
* ~~Edits by watched users~~
* ~~Edits to watched objects~~
* Edits with certain keywords
* Edits in a certain area
* Objects that have a very similar structure of a list of objects commonly drawn for vandalism (you know what we're talking about)
* Notification of edits matching the above criteria
* Other ideas


Requirements
------------

[OpenStreetMap Diff Tool](http://www.github.com/ethan-nelson/osm_diff_tool) is required. If you use the setup.py file, it should fetch the repository from pypi. Also, psycopg2 is necessary at the moment for all the database work.

Use
---

To begin use, simply call `import osmhm` after installation.

Sample calls available for now:

```
import osmhm

osmhm.run(history=False, monitor=True, suspicious=True) # Does not log full history, does watch flagged objects and users, and does look for strange changesets
```

More information will be coming soon and the tool will continue to be improved, including the option to remove the dependency on psycopg2 and a postgres database to store everything.

{'fraction_non_alphanumeric': 0.0733652312599681, 'fraction_numerical': 0.002551834130781499, 'mean_word_length': 4.550442477876106, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '998326', 'n_tokens_mistral': 823, 'n_tokens_neox': 784, 'n_words': 445}