Skip to content

Commit 0e422b6

Browse files
committed
Updated export, format arguments, and readme
- A lot of readme updates. The readme was long and meandering, it has been made more concise. - The fallback for appending items would always use a geopackage instead of another format if the user specifies it (such as geojson). This has been resolved where the format chosen is carried through all operations. - Some --format argument commands did not register in all commands. Now the argument is the same for all commands and carries through.
1 parent 6735b21 commit 0e422b6

File tree

5 files changed

+414
-111
lines changed

5 files changed

+414
-111
lines changed

README.md

Lines changed: 42 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,11 @@ Choose your Overture query, specify the country, then you're done!
77
This ETL pipeline allows you to query and extract Overture Maps data (such as roads, buildings) to upload to ArcGIS Online, download as different file types for any GIS software, or save as a local dump for continual use. This pipeline supports 176 countries worldwide with its country/ISO database, allows you to use pre-built queries or your own custom queries, and is designed to align with Overture's monthly releases. This pipeline was originally built to support the World Bank's distributed data across ArcGIS Hubs, but should work for other work flows.
88

99
## Commands
10-
- `arcgis-upload` - Publish processed data to ArcGIS Online feature layers
11-
- `export` - Export data to GeoJSON, GeoPackage, or File Geodatabase formats
12-
- `overture-dump` - High-performance local caching system for multi-country operations
10+
There are three main commands when using this pipeline.
11+
- `overture-dump` - This command caches Overture dumps with a local caching system, which is useful for multiple country uploads.
12+
- `arcgis-upload` - Publish processed data to ArcGIS Online feature layers as a one off.
13+
- `export` - Export data to GeoJSON, GeoPackage, or File Geodatabase formats without uploading to ArcGIS Online. This is useful if you just need to grab specific queried data from Overture.
14+
1315

1416
## Key Features
1517
- Automatic AGOL discovery: The pipeline will either create a new feature layer or use truncate and append based on whether or not a feature layer already exists.
@@ -54,42 +56,7 @@ On macOS/Linux:
5456
- No need to create country-specific config files, you can use the global config with a country argument
5557

5658
### 4. Run commands
57-
The Python CLI has three main commands: uploading to AGOL, downloading as geojson, or download dump for local use as needed.
58-
59-
#### Upload to ArcGIS Online:
60-
- Example with Afghanistan country parameter:
61-
`o2agol arcgis-upload roads --country afg`
62-
63-
- Or using module directly:
64-
`python -m o2agol.cli arcgis-upload roads --country afg`
65-
66-
#### Export to Multiple Formats:
67-
- Export Afghanistan roads to GeoJSON (auto-filename: afg_roads.geojson):
68-
`o2agol export roads --country lux`
69-
70-
- Export to GeoPackage format:
71-
`o2agol export buildings --country lux --format gpkg`
72-
73-
- Export raw Overture data (no AGOL transformations):
74-
`o2agol export places --country lux --format gpkg --raw`
75-
76-
- Export to custom filename with format auto-detection:
77-
`o2agol export roads lux_roads.gpkg --country lux`
78-
79-
### Review options
80-
- If needed you can always review options with the --help argument.
81-
- `o2agol --help`
82-
- `o2agol arcgis-upload --help`
83-
- `o2agol export --help`
84-
- `o2agol overture-dump --help`
85-
86-
### List Queries
87-
- You can list the available queries with this command:
88-
`o2agol list-queries`
89-
or
90-
`python -m o2agol.cli list-queries`
91-
92-
And add you own query in the global config (`src\o2agol\data\queries.yml`)
59+
The Python CLI has three main commands: uploading to AGOL `arcgis-upload` , downloading as geojson `export`, or download dump for local use as needed `overture-dump`.
9360

9461
## Outputs
9562

@@ -148,6 +115,42 @@ Below is a list of optional arguments. Useful if you need to tailor your command
148115

149116
## Examples:
150117

118+
#### Upload to ArcGIS Online:
119+
- Example with Afghanistan country parameter:
120+
`o2agol arcgis-upload roads --country afg`
121+
122+
- Or using module directly:
123+
`python -m o2agol.cli arcgis-upload roads --country afg`
124+
125+
#### Export to Multiple Formats:
126+
- Export Afghanistan roads to GeoJSON (auto-filename: afg_roads.geojson):
127+
`o2agol export roads --country lux`
128+
129+
- Export to GeoPackage format:
130+
`o2agol export buildings --country lux --format gpkg`
131+
132+
- Export raw Overture data (no AGOL transformations):
133+
`o2agol export places --country lux --format gpkg --raw`
134+
135+
- Export to custom filename with format auto-detection:
136+
`o2agol export roads lux_roads.gpkg --country lux`
137+
138+
### Review options
139+
- If needed you can always review options with the --help argument.
140+
- `o2agol --help`
141+
- `o2agol arcgis-upload --help`
142+
- `o2agol export --help`
143+
- `o2agol overture-dump --help`
144+
145+
### List Queries
146+
- You can list the available queries with this command:
147+
`o2agol list-queries`
148+
or
149+
`python -m o2agol.cli list-queries`
150+
151+
And add you own query in the global config (`src\o2agol\data\queries.yml`)
152+
153+
151154
### ArcGIS Online Upload:
152155
- `o2agol arcgis-upload roads --country afg` - Afghanistan road networks
153156
- `o2agol arcgis-upload education --country pakistan --log-to-file` - Pakistan education facilities with logging

0 commit comments

Comments
 (0)