Merge branch 'master' of https://github.com/pegler/pytzwhere

* 'master' of https://github.com/pegler/pytzwhere:
  Update README to include example for forceTZ
  add worldtest.json.gz to manifest.  bump version
  bump to 3.0.2
  Reduces size of module bt 1/3.  Achieves 94% code coverage, relating to pegler#8.  Closes pegler#45. This is also an update to pegler#46 and @seahawks code to include the files on the MANIFEST file..
  add json files to MANIFEST.in, remove obsolete .csv file

MANIFEST.in

@@ -1,3 +1,4 @@
 include LICENSE
 include README.md
-include tzwhere/tz_world.csv
+include tzwhere/tz_world_shortcuts.json
+include tzwhere/tz_world.json.gz

README.md

@@ -23,3 +23,22 @@ Dependencies:
   * `numpy` (optional)
 
   * `shapely`
+
+
+
+**forceTZ**
+
+If the coordinates provided are outside of the currently defined timezone boundaries, the `tzwhere` function will return `None`. If you would like to match to the closest timezone, use the forceTZ parameter.
+
+Example:
+
+    >>> from tzwhere import tzwhere
+    >>> tz = tzwhere.tzwhere()
+    >>> print(tz.tzNameAt(53.68193999999999, -6.239169999999998))
+    None
+
+    >>> from tzwhere import tzwhere
+    >>> tz = tzwhere.tzwhere(forceTZ=True)
+    >>> print(tz.tzNameAt(53.68193999999999, -6.239169999999998, forceTZ=True))
+    Europe/Dublin
+

setup.py

@@ -8,11 +8,11 @@
 
 setup(
     name='tzwhere',
-    version='3.0.1',
+    version='3.0.3',
     packages=['tzwhere'],
     package_data={
         'tzwhere': [
-            'tz_world.json',
+            'tz_world.json.gz',
             'tz_world_shortcuts.json'
         ]
     },

tests/test_utilities.py

@@ -0,0 +1,37 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+##################################
+# Standard library imports
+##################################
+
+import os
+import datetime
+from unittest import TestCase
+
+##################################
+# Custom library imports
+##################################
+
+from tzwhere import tzwhere
+from tzwhere.tzwhere import BASE_DIR
+
+
+####################################
+
+class TestTzwhereUtilities(TestCase):
+    def test_preparemap_class(self):
+        """
+        Tests the prepareMap class which writes shortcuts file.  Test looks
+        at modified date to see if that's equivalent to today's date
+
+        :return:
+        Unit test response
+        """
+
+        a = tzwhere.prepareMap()
+        location = os.path.join(BASE_DIR, 'tzwhere', 'tz_world_shortcuts.json')
+        date = datetime.datetime.now().date()
+        modified = datetime.datetime. \
+            fromtimestamp(os.stat(location).st_mtime).date()
+        return self.assertEqual(date, modified)

tzwhere/tzwhere.py

@@ -8,10 +8,14 @@ class are instantiated and queried directly
 
 import collections
 try:
-    import json
-except ImportError:
-    import simplejson as json
+    import ujson as json # loads 2 seconds faster than normal json
+except:
+    try:
+        import json
+    except ImportError:
+        import simplejson as json
 import math
+import gzip
 import os
 import shapely.geometry as geometry
 import shapely.prepared as prepared
@@ -26,6 +30,9 @@ class are instantiated and queried directly
     WRAP = tuple
     COLLECTION_TYPE = tuple
 
+# for navigation and pulling values/files
+this_dir, this_filename = os.path.split(__file__)
+BASE_DIR = os.path.dirname(this_dir)
 
 class tzwhere(object):
 
@@ -35,7 +42,7 @@ class tzwhere(object):
     DEFAULT_SHORTCUTS = os.path.join(os.path.dirname(__file__),
                                      'tz_world_shortcuts.json')
     DEFAULT_POLYGONS = os.path.join(os.path.dirname(__file__),
-                                    'tz_world.json')
+                                    'tz_world.json.gz')
 
     def __init__(self, forceTZ=False):
         '''
@@ -152,7 +159,11 @@ def __forceTZ__(self, possibleTimezones, latTzOptions,
 class prepareMap(object):
 
     def __init__(self):
-        featureCollection = read_tzworld('tz_world.json')
+        DEFAULT_SHORTCUTS = os.path.join(os.path.dirname(__file__),
+                                         'tz_world_shortcuts.json')
+        DEFAULT_POLYGONS = os.path.join(os.path.dirname(__file__),
+                                        'tz_world.json.gz')
+        featureCollection = read_tzworld(DEFAULT_POLYGONS)
         pgen = feature_collection_polygons(featureCollection)
         tzNamesToPolygons = collections.defaultdict(list)
         for tzname, poly in pgen:
@@ -167,7 +178,7 @@ def __init__(self):
                 tzNamesToPolygons, tzwhere.SHORTCUT_DEGREES_LONGITUDE,
                 tzwhere.SHORTCUT_DEGREES_LATITUDE)
 
-        with open('tz_world_shortcuts.json', 'w') as f:
+        with open(DEFAULT_SHORTCUTS, 'w') as f:
             json.dump(
                 (timezoneLongitudeShortcuts, timezoneLatitudeShortcuts), f)
 
@@ -224,8 +235,8 @@ def read_tzworld(path):
 
 
 def read_json(path):
-    with open(path, 'r') as f:
-        featureCollection = json.load(f)
+    with gzip.open(path, "rb") as f:
+        featureCollection = json.loads(f.read().decode("utf-8"))
     return featureCollection