You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Remove command_line.py, batch.py, their tests/fixtures, and the
example batch.py + addresses.csv. The CLI now lives in its own
repository and PyPI package (opencage-cli).
Drop tqdm and certifi (only used by the batch CLI) and the
[project.scripts] entry point. Bump to 3.4.0.
Copy file name to clipboardExpand all lines: README.md
+1-34Lines changed: 1 addition & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,8 +17,6 @@ You can find a [comprehensive tutorial for using this module on the OpenCage sit
17
17
18
18
There are two brief video tutorials on YouTube, one [covering forward geocoding](https://www.youtube.com/watch?v=9bXu8-LPr5c), one [covering reverse geocoding](https://www.youtube.com/watch?v=u-kkE4yA-z0).
19
19
20
-
The module installs an `opencage` CLI tool for geocoding files. Check `opencage --help` or the [CLI tutorial](https://opencagedata.com/tutorials/geocode-commandline).
21
-
22
20
## Working with AI / Agent Skill
23
21
24
22
There is an [Agent Skill for working with the OpenCage Geocoding API](https://github.com/OpenCageData/opencage-skills/) which includes a reference file for developing in Python using this module.
@@ -100,9 +98,6 @@ async with OpenCageGeocode(key) as geocoder:
100
98
results =await geocoder.geocode_async(address)
101
99
```
102
100
103
-
For a more complete example and links to futher tutorials on asyncronous IO see
104
-
`batch.py` in the `examples` directory.
105
-
106
101
### Non-SSL API use
107
102
108
103
If you have trouble accesing the OpenCage API with https, e.g. issues with OpenSSL
@@ -125,35 +120,7 @@ If anything goes wrong, then an exception will be raised:
125
120
126
121
## Command-line batch geocoding
127
122
128
-
Use `opencage forward` or `opencage reverse`
129
-
130
-
```
131
-
opencage forward --help
132
-
133
-
options:
134
-
-h, --help show this help message and exit
135
-
--api-key API_KEY Your OpenCage API key
136
-
--input FILENAME Input file name
137
-
--output FILENAME Output file name
138
-
--headers If the first row should be treated as a header row
139
-
--input-columns Comma-separated list of integers (default '1')
140
-
--add-columns Comma-separated list of output columns (default 'lat,lng,_type,_category,country_code,country,state,county,_normalized_city,postcode,road,house_number,confidence,formatted,json,status')
141
-
--workers Number of parallel geocoding requests (default 1)
142
-
--timeout Timeout in seconds (default 10)
143
-
--retries Number of retries (default 5)
144
-
--api-domain API domain (default api.opencagedata.com)
145
-
--optional-api-params
146
-
Extra parameters for each request (e.g. language=fr,no_dedupe=1)
147
-
--unordered Allow the output lines to be in different order (can be faster)
148
-
--limit Stop after this number of lines in the input
149
-
--dry-run Read the input file but no geocoding
150
-
--no-progress Display no progress bar
151
-
--quiet No progress bar and no messages
152
-
--overwrite Delete the output file first if it exists
153
-
--verbose Display debug information for each request
154
-
```
155
-
156
-
<imgsrc="batch-progress.gif"/>
123
+
The `opencage` CLI now lives in its own package. See [opencage-cli](https://github.com/OpenCageData/opencage-cli) — install with `pip install opencage-cli`.
0 commit comments