Metadata-Version: 2.1
Name: Cities
Version: 0.7
Summary: Cities is a simple tool for searching cities located at a given longitude and latitude range.
Home-page: https://github.com/131250208/Cities
Author: Andy Wong
Author-email: wychengpublic@163.com
License: MIT
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.6.0
Description-Content-Type: text/markdown



Cities is a simple tool for searching cities located at a given longitude and latitude range. All the cities returned are sorted by the importance of a city and the population density.

# Features
1. fast(less than 0.01s for each searching), simple and convenient.
2. cover all the cities around the world.
3. the author is cute.

# Required File
Download  the [city data](https://pan.baidu.com/s/1W_eWlaN3G7-lml0fGhx1dQ) and put it at any directory you want. Remember to set the path up when you initiate an instance.

# Example
```
from Cities import cities_retriever
cr = cities_retriever.CitiesRetriever("Sources/dict_1.json")
cities = cr.retrieve_cities(-124.71, -77.21, 25.24, 44.75, 50) # starting longitude, ending longitude, starting latitude, ending latitude, the number of the cities 
print(json.dumps(cities, indent=2))
```
# Note
it might take you a little time(13s for loading the dict) when you first invoke the retrieve method. But the loading process only occurs when you initiate an instance. The retrieving time is still stay around 0.001s ~ 0.01s(it depends on how many cities you want). The mainly time-consuming part in retrieving is a sorting part.

