Skip to content

Commit dec37f2

Browse files
author
Shiland
committed
Document address_point method
1 parent b23c8a3 commit dec37f2

1 file changed

Lines changed: 22 additions & 17 deletions

File tree

README.md

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# python-geosupport
22

33
A Python library for geocoding with NYC Planning's [Geosupport Desktop Edition](https://www1.nyc.gov/site/planning/data-maps/open-data/dwn-gde-home.page).
4-
Developed using version `17C` of Geosupport Desktop Edition.
4+
Geocode your data in fast and securely.
55

66

77
## Getting Started
88
### Prerequisites
99

10-
Install Geosupport Desktop Edition:
10+
Install Geosupport Desktop Edition (v 18b):
1111

12-
* [Geosupport Desktop Edition for Windows (32-bit)](http://www1.nyc.gov/assets/planning/download/zip/data-maps/open-data/gde_17c.zip)
13-
* [Geosupport Desktop Edition for Windows (64-bit)](http://www1.nyc.gov/assets/planning/download/zip/data-maps/open-data/gde64_17c.zip)
14-
* [Geosupport Desktop Edition for Linux](https://www1.nyc.gov/assets/planning/download/zip/data-maps/open-data/gdelx_17c.zip)
12+
* [Geosupport Desktop Edition for Windows (32-bit)](http://www1.nyc.gov/assets/planning/download/zip/data-maps/open-data/gde_18b.zip)
13+
* [Geosupport Desktop Edition for Windows (64-bit)](http://www1.nyc.gov/assets/planning/download/zip/data-maps/open-data/gde64_18b.zip)
14+
* [Geosupport Desktop Edition for Linux](https://www1.nyc.gov/assets/planning/download/zip/data-maps/open-data/gdelx_18b.zip)
1515

1616
**Windows users:** Ensure you select the correct Geosupport installation that corresponds to the Python interpreter you are using. Ex., Python 32-bit will only work with Geosupport 32-bit.
1717

@@ -41,42 +41,48 @@ $ export LD_LIBRARY_PATH=/var/geosupport/version-17c/lib/
4141

4242
3. Geocode with:
4343

44-
**Single input street address**
44+
**Single input street address** - [Function 1B](https://nycplanning.github.io/Geosupport-UPG/appendices/appendix01/#function-1b) (Boro or zip is optional)
4545
```python
4646
result = g.address(address="125 Worth st, NY, NY")
47-
```
4847

49-
**Parsed street address** (Must provide zip code or borough)
48+
result = g.address(address="125 Worth st", boro=1)
49+
```
50+
**Street address** - [Function 1B](https://nycplanning.github.io/Geosupport-UPG/appendices/appendix01/#function-1b) (Must provide zip code or borough)
5051
```python
5152
result = g.address(house_number="125", street="Worth st", zip=10013)
5253

5354
result = g.address(house_number="125", street="Worth st", boro='MANHATTAN')
5455
```
56+
**Street address point** - [Function AP](https://nycplanning.github.io/Geosupport-UPG/appendices/appendix01/#function-ap) (Must provide zip code or borough)
57+
```python
58+
result = g.address_point(house_number="125", street="Worth st", zip=10013)
5559

56-
**Borough, Block, and Lot**
60+
result = g.address(house_number="125", street="Worth st", boro='MANHATTAN')
61+
```
62+
**Borough, Block, and Lot** - [Function BL](https://nycplanning.github.io/Geosupport-UPG/appendices/appendix01/#function-bl)
5763
```python
5864
result = g.bbl(boro='1', block='00168', lot='0032')
5965
```
60-
**BIN**
66+
**BIN** - [Function BN](https://nycplanning.github.io/Geosupport-UPG/appendices/appendix01/#function-bn)
6167
```python
6268
result = g.bin(bin='1001831')
6369
```
64-
**Placename**
70+
**Placename** - [Function 1B](https://nycplanning.github.io/Geosupport-UPG/appendices/appendix01/#function-1b)
6571
```python
6672
result = g.place(place='VAN CRTLANDT MANSION', boro='bronx')
6773
```
68-
**Intersection**
74+
**Intersection** - [Function 2W](https://nycplanning.github.io/Geosupport-UPG/appendices/appendix01/#function-2-and-2w)
6975
```python
7076
result = g.intersection(street_1='ST NICHOLAS AVENUE', street_2='MENAHAN STREET', boro='QUEENS')
7177
```
72-
**Street Segment**
78+
**Street Segment** - [Function 3](https://nycplanning.github.io/Geosupport-UPG/appendices/appendix01/#function-3)
7379
```python
7480
result = g.street_segment(on_street='STORY AVENUE',
7581
cross_street_1='EVERGREEN AVENUE',
7682
cross_street_2='WHEELER AVENUE',
7783
boro='BRONX')
7884
```
79-
**Blockface**
85+
**Blockface** - [Function 3C](https://nycplanning.github.io/Geosupport-UPG/appendices/appendix01/#function-3c)
8086
```python
8187
result = g.blockface(on_street='STORY AVENUE',
8288
cross_street_1='EVERGREEN AVENUE',
@@ -85,7 +91,7 @@ $ export LD_LIBRARY_PATH=/var/geosupport/version-17c/lib/
8591
compass_direction='N')
8692
```
8793

88-
**Street Stretch**
94+
**Street Stretch** [Function 3S](https://nycplanning.github.io/Geosupport-UPG/appendices/appendix01/#function-3s)
8995
```python
9096
result = g.street_stretch(on_street='CLIFTON PLACE',
9197
cross_street_1='SAINT JAMES PLACE',
@@ -103,8 +109,7 @@ $ export LD_LIBRARY_PATH=/var/geosupport/version-17c/lib/
103109
```
104110

105111
### Known Issues
106-
* Single address inputs containing `Grand Concourse` are not parsed correctly if they do not contain `NY` or `New York` in the string.
107-
* Single address inputs with a space instead of a hyphen are not parsed correctly. Ex. `180 05 HILLSIDE AVE, QUEENS, 11432`
112+
* The single address input is experimental to issues.
108113

109114
### TODO
110115
* Improve single address input parsing

0 commit comments

Comments
 (0)