Permalink
Browse files

adds basemap readme

  • Loading branch information...
1 parent 8e43c72 commit 4c7b9bc3bb717c6140de167bc460739298b9969f @cspanring cspanring committed Apr 12, 2012
Showing with 25 additions and 0 deletions.
  1. +25 −0 basemap/README.md
View
@@ -0,0 +1,25 @@
+# MAPC Basemap data manipulations
+
+Routine tasks to be executed before data is used to render MAPC's basemap.
+
+## Usage
+
+Either directly edit `basemap.py` or add a `local_settings.py` to provice database connection parameters in form of:
+
+ HOST = 'localhost'
+ DATABASE = 'database'
+ USER = 'user'
+ PASSWORD = 'password'
+
+Import the module to a Python shell:
+
+ $ python
+ >>> import basemap
+
+### Add pretty map labels
+
+Adds column 'map_label_txt' with title case text of given labelfield to given table. In case of table named roads, USPS standardized abbreviations are used.
+
+Execute the function with a *table* and *labelfield* argument:
+
+ >>> basemap.add_map_labels("mytable","mylabeltxtfield")

0 comments on commit 4c7b9bc

Please sign in to comment.