Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 42 additions & 1 deletion docs/sections/user-guide/uploading-data.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,44 @@
# Uploading data

##
## Image requirements

Valid image formats are PNG, GIF and JPEG. Image filenames must contain a timestamp with year, month, day, hours, minutes and seconds (e.g. 20210101120000-snapshot.jpg). The timestamp in the filename makes it possible to do fast indexing of files, which is helpful when reading a large amount of images from a remote storage.

## Renaming images

If images filenames are not matching the requirements, the images have to be renamed before being uploaded. To automate this process, we recommend [this Python utility](https://github.com/mihow/ami-camera-utils) that renames image files based on their EXIF timestamp data. The script can recursively scan directories and renames files using the format `prefix-YYYYMMDDHHmmSS.ext`.

### Install the utility

First, download and install [Python](https://www.python.org/). Then try this command to make sure the installation was successful.

```bash
python --version
```

Next, install the utility.

```bash
pip install https://github.com/mihow/ami-camera-utils/archive/refs/heads/main.zip
pip install --upgrade typer
```

Then try this command to make sure the installation was successful.

```bash
photo-renamer --help
```

### Use the utility

To rename photos in a folder, use this command. Replace the dummy path with the directory containing images to rename. The script will show a confirmation prompt before proceeding.

```bash
photo-renamer "path/to/photos" --inplace
```

For more options, checkout the [utility documention](https://github.com/mihow/ami-camera-utils).

### Demo

Coming soon!