Skip to content

Commit

Permalink
Merge pull request #116 from pilona/master
Browse files Browse the repository at this point in the history
Entirely cosmetic fixes
  • Loading branch information
DenisCarriere committed Feb 28, 2015
2 parents 05e6d53 + 556079c commit 073361b
Show file tree
Hide file tree
Showing 21 changed files with 204 additions and 198 deletions.
66 changes: 33 additions & 33 deletions docs/features/Command Line Interface.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Command Line Interface

The command line tool allows you to geocode one or many strings, either
passed as an argument, passed via STDIN, or contained in a referenced file.
passed as an argument, passed via stdin, or contained in a referenced file.

```bash
$ geocode "Ottawa"
Expand Down Expand Up @@ -29,7 +29,7 @@ $ geocode `textfile.txt`
```

The output is, by default, sent to stdout, so it can be conveniently parsed
by json parsing tools like `jq`.
by JSON parsing tools like `jq`.

```bash
$ geocode `textfile.txt` | jq [.lat,.lng,.country] -c
Expand All @@ -49,26 +49,26 @@ Make the output look **--pretty**!
```bash
$ geocode "Ottawa, Ontario" --pretty
{
"status": "OK",
"city": "Ottawa",
"country": "Canada",
"provider": "bing",
"location": "Ottawa Ontario",
"state": "ON",
"status": "OK",
"city": "Ottawa",
"country": "Canada",
"provider": "bing",
"location": "Ottawa Ontario",
"state": "ON",
"bbox": {
"northeast": [
45.77197265625,
45.77197265625,
-74.90253448486328
],
],
"southwest": [
45.07920837402344,
45.07920837402344,
-76.4996109008789
]
},
"address": "Ottawa, ON",
"lat": 45.389198303222656,
"lng": -75.68800354003906,
"quality": "PopulatedPlace",
},
"address": "Ottawa, ON",
"lat": 45.389198303222656,
"lng": -75.68800354003906,
"quality": "PopulatedPlace",
"accuracy": "Rooftop"
}
```
Expand All @@ -79,29 +79,29 @@ Change the type of output between JSON/GeoJSON
$ geocode "Ottawa, Ontario" --geojson --pretty
{
"geometry": {
"type": "Point",
"type": "Point",
"coordinates": [
-75.68800354003906,
-75.68800354003906,
45.389198303222656
]
},
"type": "Feature",
},
"type": "Feature",
"properties": {
"status": "OK",
"city": "Ottawa",
"country": "Canada",
"provider": "bing",
"location": "Ottawa Ontario",
"state": "ON",
"address": "Ottawa, ON",
"quality": "PopulatedPlace",
"status": "OK",
"city": "Ottawa",
"country": "Canada",
"provider": "bing",
"location": "Ottawa Ontario",
"state": "ON",
"address": "Ottawa, ON",
"quality": "PopulatedPlace",
"accuracy": "Rooftop"
},
},
"bbox": [
-76.4996109008789,
45.07920837402344,
-74.90253448486328,
-76.4996109008789,
45.07920837402344,
-74.90253448486328,
45.77197265625
]
}
```
```
42 changes: 21 additions & 21 deletions docs/features/GeoJSON.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,33 +20,33 @@ The difference between the GeoJSON and JSON response is the `geometry` attribute
```json
{
"geometry": {
"type": "Point",
"type": "Point",
"coordinates": [
-74.0059413,
-74.0059413,
40.7127837
]
},
"type": "Feature",
},
"type": "Feature",
"properties": {
"status": "OK",
"city": "New York",
"confidence": 1,
"ok": true,
"country": "United States",
"provider": "google",
"location": "New York City",
"state": "New York",
"address": "New York, NY, USA",
"lat": 40.7127837,
"lng": -74.0059413,
"quality": "locality",
"status": "OK",
"city": "New York",
"confidence": 1,
"ok": true,
"country": "United States",
"provider": "google",
"location": "New York City",
"state": "New York",
"address": "New York, NY, USA",
"lat": 40.7127837,
"lng": -74.0059413,
"quality": "locality",
"accuracy": "APPROXIMATE"
},
},
"bbox": [
-74.25908989999999,
40.4913686,
-73.70027209999999,
-74.25908989999999,
40.4913686,
-73.70027209999999,
40.91525559999999
]
}
```
```
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Many online providers such as Google & Bing have geocoding services,
these providers do not include Python libraries and have different
JSON responses between each other.

Consistant JSON responses from various providers.
Consistent JSON responses from various providers.

```python
>>> g = geocoder.google('New York City')
Expand Down
72 changes: 36 additions & 36 deletions docs/providers/FreeGeoIP.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
FreeGeoIP.net
=============
freegeoip.net provides a public HTTP API for software developers to
search the geolocation of IP addresses. It uses a database of IP addresses
that are associated to cities along with other relevant information like
freegeoip.net provides a public HTTP API for software developers to
search the geolocation of IP addresses. It uses a database of IP addresses
that are associated to cities along with other relevant information like
time zone, latitude and longitude.

You're allowed up to 10,000 queries per hour by default. Once this
limit is reached, all of your requests will result in HTTP 403,
forbidden, until your quota is cleared.
You're allowed up to 10,000 queries per hour by default. Once this
limit is reached, all of your requests will result in HTTP 403,
forbidden, until your quota is cleared.

API Reference
-------------
Expand Down Expand Up @@ -47,23 +47,23 @@ GeoJSON
```json
{
"geometry": {
"type": "Point",
"type": "Point",
"coordinates": [
-75.691,
-75.691,
45.413
]
},
"type": "Feature",
},
"type": "Feature",
"properties": {
"status": "OK",
"city": "Ottawa",
"ip": "99.240.181.199",
"address": "Ottawa, Ontario Canada",
"provider": "freegeoip",
"time_zone": "America/Toronto",
"state": "Ontario",
"location": "99.240.181.199",
"country": "Canada",
"status": "OK",
"city": "Ottawa",
"ip": "99.240.181.199",
"address": "Ottawa, Ontario Canada",
"provider": "freegeoip",
"time_zone": "America/Toronto",
"state": "Ontario",
"location": "99.240.181.199",
"country": "Canada",
"postal": "K2P"
}
}
Expand All @@ -72,29 +72,29 @@ JSON
----
```json
{
"status": "OK",
"city": "Ottawa",
"ip": "99.240.181.199",
"address": "Ottawa, Ontario Canada",
"provider": "freegeoip",
"time_zone": "America/Toronto",
"state": "Ontario",
"location": "99.240.181.199",
"country": "Canada",
"lat": 45.413,
"lng": -75.691,
"status": "OK",
"city": "Ottawa",
"ip": "99.240.181.199",
"address": "Ottawa, Ontario Canada",
"provider": "freegeoip",
"time_zone": "America/Toronto",
"state": "Ontario",
"location": "99.240.181.199",
"country": "Canada",
"lat": 45.413,
"lng": -75.691,
"postal": "K2P"
}
```
OSM
---
```json
{
"addr:postal": "K2P",
"addr:city": "Ottawa",
"addr:state": "Ontario",
"y": 45.413,
"x": -75.691,
"addr:postal": "K2P",
"addr:city": "Ottawa",
"addr:state": "Ontario",
"y": 45.413,
"x": -75.691,
"addr:country": "Canada"
}
```
```
4 changes: 2 additions & 2 deletions docs/providers/GeoNames.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# GeoNames

GeoNames is mainly using REST webservices. Find nearby postal codes / reverse geocoding
This service comes in two flavors.You can either pass the lat/long or a postalcode/placename.
This service comes in two flavours. You can either pass the lat/long or a postalcode/placename.

Using Geocoder you can retrieve GeoNames's geocoded data from GeoNames REST Web Services.

Expand Down Expand Up @@ -37,4 +37,4 @@ Using Geocoder you can retrieve GeoNames's geocoded data from GeoNames REST Web

* [GitHub Repo](https://github.com/DenisCarriere/geocoder)
* [GitHub Wiki](https://github.com/DenisCarriere/geocoder/wiki)
* [GeoNames REST Web Services](http://www.geonames.org/export/web-services.html)
* [GeoNames REST Web Services](http://www.geonames.org/export/web-services.html)
28 changes: 14 additions & 14 deletions docs/providers/GeoOttawa.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# GeoOttawa

This data was collected in the field using GPS software on handheld computers. Not all information has been verified for accuracy and therefore should only be used in an advisory capacity. Forestry Services reserves the right to revise the data pursuant to further inspection/review. If you find any errors or omissions, please report them to 3-1-1.
This data was collected in the field using GPS software on handheld computers. Not all information has been verified for accuracy and therefore should only be used in an advisory capacity. Forestry Services reserves the right to revise the data pursuant to further inspection/review. If you find any errors or omissions, please report them to 3-1-1.

[GeoOttawa Map](http://maps.ottawa.ca/geoottawa/)

Expand All @@ -17,18 +17,18 @@ This data was collected in the field using GPS software on handheld computers. N

```json
{
"status": "OK",
"city": "Ottawa",
"ok": true,
"country": "Canada",
"provider": "ottawa",
"state": "Ontario",
"location": "453 Booth Street",
"address": "453 BOOTH ST, K1R7K9",
"lat": 45.40490114288874,
"lng": -75.70755144879519,
"postal": "K1R7K9",
"housenumber": 453,
"status": "OK",
"city": "Ottawa",
"ok": true,
"country": "Canada",
"provider": "ottawa",
"state": "Ontario",
"location": "453 Booth Street",
"address": "453 BOOTH ST, K1R7K9",
"lat": 45.40490114288874,
"lng": -75.70755144879519,
"postal": "K1R7K9",
"housenumber": 453,
"accuracy": 100
}
```
```
6 changes: 3 additions & 3 deletions docs/providers/Google.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Google

Geocoding is the process of converting addresses (like "1600 Amphitheatre Parkway,
Mountain View, CA") into geographic coordinates (like latitude 37.423021 and
Geocoding is the process of converting addresses (like "1600 Amphitheatre Parkway,
Mountain View, CA") into geographic coordinates (like latitude 37.423021 and
longitude -122.083739), which you can use to place markers or position the map.
Using Geocoder you can retrieve google's geocoded data from Google Geocoding API.

Expand Down Expand Up @@ -46,4 +46,4 @@ Using Geocoder you can retrieve google's geocoded data from Google Geocoding API

* [GitHub Repo](https://github.com/DenisCarriere/geocoder)
* [GitHub Wiki](https://github.com/DenisCarriere/geocoder/wiki)
* [Google Geocoding API](https://developers.google.com/maps/documentation/geocoding/)
* [Google Geocoding API](https://developers.google.com/maps/documentation/geocoding/)

0 comments on commit 073361b

Please sign in to comment.