{"id":13631700,"url":"https://github.com/agorf/adri","last_synced_at":"2025-04-17T22:31:35.223Z","repository":{"id":62553033,"uuid":"155547795","full_name":"agorf/adri","owner":"agorf","description":"Organize photos by date and location in a directory structure","archived":false,"fork":false,"pushed_at":"2022-10-25T18:24:07.000Z","size":50,"stargazers_count":16,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-31T15:18:48.732Z","etag":null,"topics":["camera","directories","exif","filesystem","geocoding","google-maps-api","headers","jpeg","location","organize","phone","photographs","photos","smartphone","tidy","tiff"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/agorf.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-10-31T11:40:52.000Z","updated_at":"2023-12-28T23:38:53.000Z","dependencies_parsed_at":"2022-11-03T04:15:28.835Z","dependency_job_id":null,"html_url":"https://github.com/agorf/adri","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agorf%2Fadri","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agorf%2Fadri/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agorf%2Fadri/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agorf%2Fadri/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/agorf","download_url":"https://codeload.github.com/agorf/adri/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223768631,"owners_count":17199356,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["camera","directories","exif","filesystem","geocoding","google-maps-api","headers","jpeg","location","organize","phone","photographs","photos","smartphone","tidy","tiff"],"created_at":"2024-08-01T22:02:34.952Z","updated_at":"2024-11-08T23:31:25.762Z","avatar_url":"https://github.com/agorf.png","language":"Ruby","funding_links":[],"categories":["Ruby"],"sub_categories":[],"readme":"# adri [![Gem Version](https://badge.fury.io/rb/adri.svg)](http://badge.fury.io/rb/adri)\n\nadri organizes JPEG/TIFF photographs according to their EXIF date and location\ndata into a custom directory structure.\n\nIn other words, it turns this:\n\n```sh\n$ tree photos/\nphotos/\n├── IMG100001.jpg\n├── IMG100002.jpg\n└── IMG100003.jpg\n```\n\nTo this:\n\n```sh\n$ tree photos/\nphotos/\n└── 2018/\n    └── 10/\n        └── 14/\n            └── London\n                ├── IMG100001.jpg\n                ├── IMG100002.jpg\n                └── IMG100003.jpg\n```\n\n## Installation\n\nInstall the necessary packages. For Debian/Ubuntu, issue:\n\n```sh\nsudo apt install ruby-full git build-essential libexif-dev\n```\n\nInstall adri:\n\n```sh\nsudo gem install adri\n```\n\n## Configuration\n\n### API key\n\nThe GPS coordinates (latitude, longitude) of each photograph's EXIF headers are\nconverted to a corresponding location name using the [Google Maps API][]. For\nthis, you need a free [API key][] with the Geocoding API enabled.\n\nYou can set the `ADRI_GOOGLE_API_KEY` environment variable in your shell's\nconfiguration file. For Bash, issue:\n\n```sh\n$ cat \u003e\u003e.~/.bashrc\nexport ADRI_GOOGLE_API_KEY=yourapikeyhere\n^D\n```\n\nNote: `^D` stands for `Ctrl-D`\n\nYou can also pass the API key as a command line option with `--api-key`. This\noverrides the environment variable.\n\n### Location language\n\nIt's possible to configure the language (default is `en` for English) used in\nlocation names by setting the `ADRI_LOCALE` environment variable in your shell's\nconfiguration file.\n\nTo set the language to Greek in Bash, issue:\n\n```sh\n$ cat \u003e\u003e.~/.bashrc\nexport ADRI_LOCALE=el\n^D\n```\n\nNote: `^D` stands for `Ctrl-D`\n\nYou can also pass the language as a command line option with `--locale`. This\noverrides the environment variable.\n\n## Use\n\nTo get the help text, issue:\n\n```sh\n$ adri -h\nusage: adri [options] \u003cpath\u003e...\n    -p, --prefix       Place everything under this path (default: photo parent directory)\n    -f, --path-format  Format path with strftime and %{location} (default: %Y/%m/%d/%{location})\n    --api-key          Google Maps API key (default: $ADRI_GOOGLE_API_KEY)\n    --locale           Locale to use for %{location} in path format (default: $ADRI_LOCALE or en)\n    --run              Perform changes instead of a dry run\n    -q, --quiet        Do not print operations\n    --version          Print program version\n    -h, --help         Print help text\n```\n\n### Dry run mode (default)\n\nBy default, adri runs in dry run mode, printing `(DRY RUN)` at the end of each\nline. This means it simply prints out what it would do, without actually doing\nit:\n\n```sh\n$ pwd\n/home/agorf/work/adri/\n$ tree photos/\nphotos/\n├── IMG100001.jpg\n├── IMG100002.jpg\n└── IMG100003.jpg\n$ adri photos/*.jpg\n/home/agorf/work/adri/photos/IMG100001.jpg -\u003e /home/agorf/work/adri/photos/2018/10/14/London/IMG100001.jpg (DRY RUN)\n/home/agorf/work/adri/photos/IMG100002.jpg -\u003e /home/agorf/work/adri/photos/2018/10/14/London/IMG100002.jpg (DRY RUN)\n/home/agorf/work/adri/photos/IMG100003.jpg -\u003e /home/agorf/work/adri/photos/2018/10/14/London/IMG100003.jpg (DRY RUN)\n$ tree photos/\nphotos/\n├── IMG100001.jpg\n├── IMG100002.jpg\n└── IMG100003.jpg\n```\n\n### Run mode\n\nTo apply the changes, use the `--run` option:\n\n```sh\n$ adri --run photos/*.jpg\n/home/agorf/work/adri/photos/IMG100001.jpg -\u003e /home/agorf/work/adri/photos/2018/10/14/London/IMG100001.jpg\n/home/agorf/work/adri/photos/IMG100002.jpg -\u003e /home/agorf/work/adri/photos/2018/10/14/London/IMG100002.jpg\n/home/agorf/work/adri/photos/IMG100003.jpg -\u003e /home/agorf/work/adri/photos/2018/10/14/London/IMG100003.jpg\n$ tree photos/\nphotos/\n└── 2018/\n    └── 10/\n        └── 14/\n            └── London/\n                ├── IMG100001.jpg\n                ├── IMG100002.jpg\n                └── IMG100003.jpg\n```\n\n### Path prefix\n\nTo place everything under a path other than the parent directory of each\nphotograph, use the `--prefix` option:\n\n```sh\n$ adri --prefix . photos/*.jpg\n/home/agorf/work/adri/photos/IMG100001.jpg -\u003e /home/agorf/work/adri/2018/10/14/London/IMG100001.jpg (DRY RUN)\n/home/agorf/work/adri/photos/IMG100002.jpg -\u003e /home/agorf/work/adri/2018/10/14/London/IMG100002.jpg (DRY RUN)\n/home/agorf/work/adri/photos/IMG100003.jpg -\u003e /home/agorf/work/adri/2018/10/14/London/IMG100003.jpg (DRY RUN)\n```\n\n### Path format\n\nThe default path format is `%Y/%m/%d/%{location}` which stands for\n_year/month/day/location_. Everything other than `%{location}` is formatted\naccording to [strftime(3)][strftime].\n\nIt is possible to specify a custom path with the `--path-format` option:\n\n```sh\n$ adri --path-format '%{location}/%b %Y/%d' photos/*.jpg\n/home/agorf/work/adri/photos/IMG100001.jpg -\u003e /home/agorf/work/adri/photos/London/Oct 2018/14/IMG100001.jpg (DRY RUN)\n/home/agorf/work/adri/photos/IMG100002.jpg -\u003e /home/agorf/work/adri/photos/London/Oct 2018/14/IMG100002.jpg (DRY RUN)\n/home/agorf/work/adri/photos/IMG100003.jpg -\u003e /home/agorf/work/adri/photos/London/Oct 2018/14/IMG100003.jpg (DRY RUN)\n```\n\n### Processing many photos\n\nIt's also possible to process many photos at once by passing space-separated\nfile names and directories (in which case adri will [recurse][]):\n\n```sh\n$ adri photos/IMG100001.jpg photos/IMG100002.jpg photos/IMG100003.jpg\n/home/agorf/work/adri/photos/IMG100001.jpg -\u003e /home/agorf/work/adri/photos/2018/10/14/London/IMG100001.jpg (DRY RUN)\n/home/agorf/work/adri/photos/IMG100002.jpg -\u003e /home/agorf/work/adri/photos/2018/10/14/London/IMG100002.jpg (DRY RUN)\n/home/agorf/work/adri/photos/IMG100003.jpg -\u003e /home/agorf/work/adri/photos/2018/10/14/London/IMG100003.jpg (DRY RUN)\n$ adri photos/\n/home/agorf/work/adri/photos/IMG100001.jpg -\u003e /home/agorf/work/adri/photos/2018/10/14/London/IMG100001.jpg (DRY RUN)\n/home/agorf/work/adri/photos/IMG100002.jpg -\u003e /home/agorf/work/adri/photos/2018/10/14/London/IMG100002.jpg (DRY RUN)\n/home/agorf/work/adri/photos/IMG100003.jpg -\u003e /home/agorf/work/adri/photos/2018/10/14/London/IMG100003.jpg (DRY RUN)\n```\n\n## License\n\n[MIT][]\n\n## Author\n\n[Angelos Orfanakos](https://agorf.gr/contact/)\n\n[Bundler]: https://bundler.io/\n[Google Maps API]: https://developers.google.com/maps/documentation/javascript/examples/geocoding-reverse\n[API key]: https://cloud.google.com/maps-platform/#get-started\n[MIT]: https://github.com/agorf/adri/blob/master/LICENSE.txt\n[recurse]: https://softwareengineering.stackexchange.com/a/184600/316578\n[strftime]: http://man7.org/linux/man-pages/man3/strftime.3.html\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagorf%2Fadri","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fagorf%2Fadri","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagorf%2Fadri/lists"}