Added openaddr-update-dotmap script with documentation

slibby · Sep 30, 2015 · c48870c · c48870c
1 parent 06b4ac5
commit c48870c
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/docs/components.md b/docs/components.md
@@ -68,3 +68,12 @@ This Python script is meant to be run about once per day. It downloads all curre
 * Code can be found [in `openaddr/ci/collect.py`](https://github.com/openaddresses/machine/blob/2.1.8/openaddr/ci/collect.py).
 * Resulting collections are linked from [results.openaddresses.io](http://results.openaddresses.io).
 * A nightly cron task for this script runs every evening from the same EC2 instance as _Webhook_.
+
+### <a name="dotmap">Dotmap</a>
+
+This Python script is meant to be run about once per week. It downloads all current processed data, generates an MBTiles file of worldwide address point coverage with [Tippecanoe](https://github.com/mapbox/tippecanoe), and uploads it to [Mpabox](persistence.md#mapbox).
+
+* Run via the [script `openaddr-update-dotmap`](https://github.com/openaddresses/machine/blob/update-dotmap-%23210/setup.py#L48).
+* Code can be found [in `openaddr/ci/collect.py`](https://github.com/openaddresses/machine/blob/update-dotmap-%23210/openaddr/dotmap.py).
+* Resulting map of dots is show at [openaddresses.io](http://openaddresses.io).
+* We plan to set up a weekly cron task for this script on the OpenStreetMap U.S. server.
diff --git a/docs/persistence.md b/docs/persistence.md
@@ -45,3 +45,10 @@ We use the S3 bucket `data.openaddresses.io` to store new and historical data.
 
 * S3 access is handled via [the Boto library](http://docs.pythonboto.org/en/latest/).
 * Boto expects current AWS credentials in the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables.
+
+<a name="mapbox">Mapbox</a>
+------
+
+We use the Mapbox API account `open-addresses` to store a tiled dot map with worldwide locations of address points.
+
+* Uploads are handled via [the Boto3 library](https://boto3.readthedocs.org), using credentials granted by the Mapbox API.
diff --git a/setup.py b/setup.py
@@ -45,6 +45,7 @@
             'openaddr-ci-worker = openaddr.ci.worker:main',
             'openaddr-enqueue-sources = openaddr.ci.enqueue:main',
             'openaddr-collect-extracts = openaddr.ci.collect:main',
+            'openaddr-update-dotmap = openaddr.dotmap:main',
         ]
     ),
     package_data = {