Skip to content

Commit

Permalink
more on readme
Browse files Browse the repository at this point in the history
  • Loading branch information
buck heroux committed Oct 10, 2014
1 parent 0df4791 commit 158e970
Showing 1 changed file with 34 additions and 5 deletions.
39 changes: 34 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,40 @@ Built off of the TileSystem static class outlined here: http://msdn.microsoft.co
Converts a lat,lon to pixel space to tile space to a quadkey


import quadkey
import quadkey

qk = quadkey.from_geo((-105, 40), 17)
print qk.key # => 02310101232121212
assert qk.level is 17
tile = qk.to_tile() # => [(x, y), z]
qk = quadkey.from_geo((-105, 40), 17)
print qk.key # => 02310101232121212
assert qk.level is 17
tile = qk.to_tile() # => [(x, y), z]

Not a lot of documentation here, but the implementation has quite a bit, so look at the QuadKey definitions for better documention


Install
-------

The package on pypi is quadtweet, so the recommended installation is with pip

pip install quadkey

Methods
-------

There are many straightforward methods, so I'll only go into detail of the unique ones

* children()
* parent()
* is_ancestor()
* is_descendent()
* area()
*

###difference(to)

Gets the quadkeys between self and to forming a rectangle, inclusive.

###unwind()

Gets a list of all ancestors in descending order by level, inclusive.

0 comments on commit 158e970

Please sign in to comment.