Skip to content

Commit 18d2593

Browse files
authored
chore: release 0.9.2 (#544)
* release 0.9.2 * update README * readme * readme * update readme * update readme * update * update * update * update * chore: hide senstive logs (#546) * chore: hide senstive logs * assert * rename
1 parent 42803dc commit 18d2593

File tree

3 files changed

+90
-52
lines changed

3 files changed

+90
-52
lines changed

README.md

Lines changed: 87 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,30 @@ Mapillary Tools is a library for processing and uploading images to [Mapillary](
44

55
<!--ts-->
66

7-
* [Quickstart](#quickstart)
8-
* [Requirements](#requirements)
9-
* [Installation](#installation)
10-
* [Video Support](#video-support)
11-
* [Usage](#usage)
12-
- [Process](#process)
13-
- [Upload Images](#upload-images)
14-
- [Upload BlackVue Videos](#upload-blackvue-videos)
15-
- [Video Process](#video-process)
16-
- [Authenticate](#authenticate)
17-
- [Aliases](#aliases)
18-
* [Advanced Usage](#advanced-usage)
19-
- [Image Description](#image-description)
20-
- [Zip Images](#zip-images)
21-
- [Upload API](#upload-api)
22-
* [Troubleshooting](#troubleshooting)
23-
* [Development](#development)
7+
- [Quickstart](#quickstart)
8+
- [Requirements](#requirements)
9+
- [Installation](#installation)
10+
- [Usage](#usage)
11+
- [Image Process](#image-process)
12+
- [Upload Images](#upload-images)
13+
- [Upload BlackVue Videos](#upload-blackvue-videos)
14+
- [Upload CAMM Videos](#upload-camm-videos)
15+
- [Advanced Usage](#advanced-usage)
16+
- [Client-side Video Process](#client-side-video-process)
17+
- [Authenticate](#authenticate)
18+
- [Aliases](#aliases)
19+
- [Image Description](#image-description)
20+
- [Zip Images](#zip-images)
21+
- [Upload API](#upload-api)
22+
- [Troubleshooting](#troubleshooting)
23+
- [Development](#development)
2424

2525
<!--te-->
2626

2727
## Quickstart
2828

2929
Download the latest `mapillary_tools` binaries for your platform
30-
[here](https://github.com/mapillary/mapillary_tools/releases/tag/v0.9.0) first.
30+
[here](https://github.com/mapillary/mapillary_tools/releases/tag/v0.9.2) first.
3131
See [more installation instructions](#installation) below.
3232

3333
Process and upload imagery:
@@ -36,6 +36,12 @@ Process and upload imagery:
3636
mapillary_tools process_and_upload "path/to/images/"
3737
```
3838

39+
Upload [CAMM](https://developers.google.com/streetview/publish/camm-spec) videos:
40+
41+
```shell
42+
mapillary_tools upload_camm "path/to/camm_videos/"
43+
```
44+
3945
Upload BlackVue videos:
4046

4147
```shell
@@ -95,28 +101,9 @@ Termux:
95101
mv -v storage/dcim/mapillaryimages mapillaryimages
96102
```
97103

98-
## Video Support
99-
100-
To [process videos](#video-process), you will also need to install `ffmpeg`.
101-
102-
You can download `ffmpeg` from [here](https://ffmpeg.org/download.html). Make sure it is executable and put the
103-
downloaded binaries in your `$PATH`. You can also install `ffmpeg` with your favourite package manager. For example:
104-
105-
On macOS, use [Homebrew](https://brew.sh/):
106-
107-
```shell
108-
brew install ffmpeg
109-
```
110-
111-
On Debian/Ubuntu:
112-
113-
```shell
114-
sudo apt install ffmpeg
115-
```
116-
117104
## Usage
118105

119-
### Process
106+
### Image Process
120107

121108
The `process` command geotags images in the given directory. It extracts the required and optional metadata from image
122109
EXIF (or the other supported geotag sources), and writes all the metadata (or process errors) in
@@ -167,28 +154,80 @@ mapillary_tools upload "path/to/images/" \
167154

168155
### Upload BlackVue Videos
169156

170-
BlackVue videos can be uploaded with the `upload` command and will be processed on Mapillary servers.
157+
BlackVue videos can be uploaded with the `upload_blackvue` command directly, and they will be processed on Mapillary servers.
158+
159+
New in version [v0.8.2](https://github.com/mapillary/mapillary_tools/releases/tag/v0.8.2).
171160

172161
#### Examples
173162

174-
Upload a BlackVue video with file name `video_file_name.mp4` to user `mly_user` for organization `mly_organization_id`
175-
. It is optional to specify `--user_name` if you have only one user [authenticated](#authenticate).
163+
Upload a BlackVue video with file name `video_file_name.mp4` to user `mly_user` for organization `mly_organization_id`.
164+
It is optional to specify `--user_name` if you have only one user [authenticated](#authenticate).
176165

177166
```shell
178167
mapillary_tools upload_blackvue "video_file_name.mp4" \
179168
--user_name "mly_user" \
180169
--organization_key "mly_organization_id"
181170
```
182171

183-
Upload all BlackVue videos (*.mp4) under the folder:
172+
Upload all BlackVue videos (\*.mp4) under the folder:
184173

185174
```shell
186175
mapillary_tools upload_blackvue "path/to/blackvue_videos/"
187176
```
188177

189-
### Video Process
178+
### Upload CAMM Videos
179+
180+
[CAMM](https://developers.google.com/streetview/publish/camm-spec) videos can be uploaded with the `upload_camm` command directly,
181+
and will be processed on Mapillary servers.
182+
183+
New in version [v0.9.2](https://github.com/mapillary/mapillary_tools/releases/tag/v0.9.2).
184+
185+
#### Examples
186+
187+
Upload a CAMM video with file name `video_file_name.mp4` to user `mly_user` for organization `mly_organization_id`.
188+
It is optional to specify `--user_name` if you have only one user [authenticated](#authenticate).
189+
190+
```shell
191+
mapillary_tools upload_camm "video_file_name.mp4" \
192+
--user_name "mly_user" \
193+
--organization_key "mly_organization_id"
194+
```
195+
196+
Upload all CAMM videos (\*.mp4) under the folder:
197+
198+
```shell
199+
mapillary_tools upload_camm "path/to/camm_videos/"
200+
```
201+
202+
## Advanced Usage
203+
204+
### Client-side Video Process
205+
206+
Client-side video processing allows users to process and upload other videos that can't be uploaded directly,
207+
and configure sample intervals, or the other processing parameters.
208+
209+
#### Install FFmpeg
210+
211+
To [process videos locally](#video-process), you will need to install `ffmpeg`.
190212

191-
Video process involves two commands:
213+
You can download `ffmpeg` from [here](https://ffmpeg.org/download.html). Make sure it is executable and put the
214+
downloaded binaries in your `$PATH`. You can also install `ffmpeg` with your favourite package manager. For example:
215+
216+
On macOS, use [Homebrew](https://brew.sh/):
217+
218+
```shell
219+
brew install ffmpeg
220+
```
221+
222+
On Debian/Ubuntu:
223+
224+
```shell
225+
sudo apt install ffmpeg
226+
```
227+
228+
#### Video Process
229+
230+
Client-side video process involves two commands:
192231

193232
1. `sample_video`: sample videos into images, and insert capture times to the image EXIF. Capture time is calculated
194233
based on the video start time and sampling interval. This is where `ffmpeg` is being used.
@@ -301,15 +340,13 @@ mapillary_tools sample_video "path/to/videos/" "path/to/videos/mapillary_sampled
301340
mapillary_tools process_and_upload "path/to/videos/mapillary_sampled_video_frames/"
302341
```
303342

304-
## Advanced Usage
305-
306343
### Image Description
307344

308345
As the output, the `procss` command generates `mapillary_image_description.json` under the image directory by default.
309346
The file contains an array of objects, each of which records the metadata of one image in the image directory. The
310347
metadata is validated
311-
by [the image description schema](https://github.com/mapillary/mapillary_tools/tree/master/schema/image_description_schema.json)
312-
. Here is a minimal example:
348+
by [the image description schema](https://github.com/mapillary/mapillary_tools/tree/master/schema/image_description_schema.json).
349+
Here is a minimal example:
313350

314351
```json
315352
[
@@ -387,7 +424,7 @@ Zip processed images in `path/to/images/` and write zip files in `path/to/zipped
387424
mapillary_tools zip "path/to/images/" "path/to/zipped_images/"
388425
```
389426

390-
Upload all the zip files (*.zip) under the folder:
427+
Upload all the zip files (\*.zip) under the folder:
391428

392429
```shell
393430
mapillary_tools upload_zip "path/to/zipped_images/"
@@ -535,6 +572,7 @@ black mapillary_tools tests
535572
```
536573

537574
Release a new version:
575+
538576
```shell
539577
# Assume you are releasing v0.9.1-beta
540578

mapillary_tools/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
VERSION = "0.9.0"
1+
VERSION = "0.9.2"

mapillary_tools/upload.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -565,11 +565,11 @@ def upload(
565565
if file_type == "images":
566566
image_paths = utils.find_images(import_paths, skip_subfolders=skip_subfolders)
567567
# find descs that match the image paths from the import paths
568-
resolved_import_paths = set(p.resolve() for p in image_paths)
568+
resolved_image_paths = set(p.resolve() for p in image_paths)
569569
specified_descs = [
570570
d
571571
for d in (descs or [])
572-
if Path(d["filename"]).resolve() in resolved_import_paths
572+
if Path(d["filename"]).resolve() in resolved_image_paths
573573
]
574574
_upload_images(mly_uploader, specified_descs, stats)
575575

0 commit comments

Comments
 (0)