https://github.com/negrel/photosort
:camera: A pictures/files organizer.
https://github.com/negrel/photosort
exif photos rust
Last synced: 2 months ago
JSON representation
:camera: A pictures/files organizer.
- Host: GitHub
- URL: https://github.com/negrel/photosort
- Owner: negrel
- License: mit
- Created: 2022-08-15T17:59:04.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-11-13T12:27:19.000Z (over 3 years ago)
- Last Synced: 2025-02-25T20:20:55.637Z (over 1 year ago)
- Topics: exif, photos, rust
- Language: Rust
- Homepage:
- Size: 133 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# :camera: `photosort` - A pictures/files organizer.
A simple CLI/daemon program to sorts your pictures/files.
## Getting started
Let's start by installing `photosort`.
### Installation
You can install `photosort` using one of the following methods:
```shell
# Using cargo
cargo install photosort
# Using docker
docker pull docker.io/negrel/photosort
# or podman
podman pull docker.io/negrel/photosort
```
### Usage
```shell
# Print help informations
photosort --help
# Using docker
docker run --rm -it negrel/photosort --help
```
Sort given `/path/to/src1` and `/path/to/src2` directories/files recursively using
`/path/to/dst/:file.name:` template. Files and directories are replicated using
hardlink and fallback to softlink if the primer fails.
```shell
photosort sort -r hardlink -r softlink "/path/to/dst/:file.name:" /path/to/src1 /path/to/src2 ...
```
Watch directories and sort them as new files are added:
```shell
photosort watch --daemon -r hardlink -r copy "/path/to/dst/:file.name:" /path/to/src1 /path/to/src2 ...
```
## Template variables
The following template variables are available for now. If you're missing other variables,
don't hesitate to make a PR !
| Variable | Description |
| :------- | :---------- |
| `file.path` | Absolute path to file. |
| `file.name` | File name. |
| `file.stem` | Extracts the stem (non-extension) portion of the filename. |
| `file.extension` | Extracts the extension part of the filename. |
| `file.name.date` | Parse RFC3339 date from filename (with optional separator: `-` `_`) |
| `file.name.date.year` | Year extracted from filename. |
| `file.name.date.month` | Month extracted from filename. |
| `file.name.date.day` | Day extracted from filename. |
| `file.md.creation_date` | File creation date in RFC3339 format. |
| `file.md.creation_date.year` | Year extracted from file creation date. |
| `file.md.creation_date.month` | Month extracted from file creation date. |
| `file.md.creation_date.day` | Day extracted from file creation date. |
| `exif.date` | Exif date in RFC3339 format. |
| `exif.date.year` | Year extracted from DateTime exif field. |
| `exif.date.month` | Month extracted from DateTime exif field. |
| `exif.date.day` | Day extracted from DateTime exif field. |
### Composed template variables
The following composed template variables are available for now:
| Variable | Source variables | Description |
| :------- | :--------------- | :---------- |
| `date` | `exif.date` -> `file.name.date` -> `file.md.creation_date` | Date in RFC3339 format. |
| `date.year` | `exif.date.year` -> `file.name.date.year` -> `file.md.creation_date.year` | The full proleptic Gregorian year, zero-padded to 4 digits. |
| `date.month` | `exif.date.month` -> `file.name.date.month` -> `file.md.creation_date.month` | Month number (01–12), zero-padded to 2 digits. |
| `date.day` | `exif.date.day` -> `file.name.date.day` -> `file.md.creation_date.day` | Day number (01–31), zero-padded to 2 digits. |
## Contributing
If you want to contribute to `photosort` to add a feature or improve the code contact
me at [negrel.dev@protonmail.com](mailto:negrel.dev@protonmail.com), open an
[issue](https://github.com/negrel/photosort/issues) or make a
[pull request](https://github.com/negrel/photosort/pulls).
## :stars: Show your support
Please give a :star: if this project helped you!
[](https://www.buymeacoffee.com/negrel)
## :scroll: License
MIT © [Alexandre Negrel](https://www.negrel.dev/)