Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wiringbits/my-photo-timeline
A simple command-line app to organize your local photos by dates (year/month) on your local file system, for those who don't store photos in the cloud
https://github.com/wiringbits/my-photo-timeline
graalvm hacktoberfest photos scala
Last synced: about 1 month ago
JSON representation
A simple command-line app to organize your local photos by dates (year/month) on your local file system, for those who don't store photos in the cloud
- Host: GitHub
- URL: https://github.com/wiringbits/my-photo-timeline
- Owner: wiringbits
- License: mit
- Created: 2020-08-07T04:39:16.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-05-06T05:54:11.000Z (over 1 year ago)
- Last Synced: 2023-05-06T07:04:23.031Z (over 1 year ago)
- Topics: graalvm, hacktoberfest, photos, scala
- Language: Scala
- Homepage: https://wiringbits.net
- Size: 1010 KB
- Stars: 35
- Watchers: 2
- Forks: 8
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# My Photo Timeline
My Photo Timeline is a simple command-line application to organize your photos by dates on your local file system.
The app works in Linux/Windows/MacOs, just go to the [releases](https://github.com/wiringbits/my-photo-timeline/releases) and download the latest binary for your system.
## Why?
While not storing your photos in the cloud, you usually end up with lots of directories with unorganized photos, and lots of duplicated ones. My Photo Timeline can take a all such directories, and organize the photos by its creation date (year/month) excluding duplicates.
I initially created this to be able to fill a family album, where I needed to choose some pictures per month, unfortunately, I wasn't able to find any software doing this while holding my photos out of the cloud, and ended up writing it.
## Example
You can collect all your photo directories in a single root directory, and just run the app (`--dry-run` doesn't alter your file system, it's recommended to try that first):
- `./my-photo-timeline --source ~/Desktop/test-photos --output ~/Desktop/test-output --dry-run`
The `test-photos` directory could look like:
```
test-photos
├── img1.jpg
├── img1-again.jpg
├── invalid
│ ├── img2-no-metadata.jpg
├── img3.jpg
├── img4.jpg
├── img5.jpg
```
Producing the `test-output` directory like:
```
test-output
├── duplicated
│ ├── img1-again.jpg
├── invalid
│ ├── img2-no-metadata.jpg
└── organized
├── 2009
│ └── 03-march
│ ├── img1.jpg
├── 2010
│ ├── 07-july
│ │ ├── img3.jpg
│ │ └── img4.jpg
│ ├── 09-september
│ │ ├── img5.jpg
```
Where:
- `test-output/duplicated` has the photos were detected as duplicated.
- `test-output/invalid` has the photos (or non-photos) where the app couldn't detect the creation date.
- `test-output/organized` has the photos organized by date, the format being `year/month/photo-name`.
## How?
The source directory is analyzed recursively to find all files including the proper creation date metadata, the duplicate detection uses a SHA-256 to speed up the comparison process.
Currently, the app looks into several potential metadata tags, which could even organize some video files, but such feature is not supported properly yet, when the metadata is not available, the app tries to get the creation date from the filename (yyyymmdd...).
## Development
You will need to install [sbt](https://www.scala-sbt.org/), [IntelliJ](https://www.jetbrains.com/idea/) is the recommended IDE, be sure to setup your IntelliJ to format the code with [scalafmt](https://scalameta.org/scalafmt/docs/installation.html#intellij) to keep the code consistent.
### Compile
Just run `sbt compile` to compile the app.
### Test
To test manually, you can launch the sbt interactive console with `sbt`, and then, run commands there with `run --dry-run --source /home/dell/projects/mine/photo-organizer/test-data --output /home/dell/projects/mine/photo-organizer/output` (replace the directories).
### Native package
Package the native image with `sbt nativeImage`, which you can try by running `target/native-image/my-photo-timeline` (append `.exe` if you are on Windows).
## Troubleshooting
There may be images with proper metadata that aren't being organized, the recommended way to fix the issue is to isolate those images, and use the `--debug` flag while running the app (lookg for the `Failed to find metadata` pattern), you can take the output to [create an issue](https://github.com/wiringbits/my-photo-timeline/issues/new) so that we can fix the bug.
Another way is to run the app without the native image to see if you see the same effect, it is very likely that the issue relates to underlying libraries using reflection to invoke classes that aren't in the native build.