{"id":17126386,"url":"https://github.com/kellpossible/photo-captioner","last_synced_at":"2025-04-13T06:27:28.439Z","repository":{"id":36177152,"uuid":"222106806","full_name":"kellpossible/photo-captioner","owner":"kellpossible","description":"A command line tool to assist with creating and editing captions for a gallery of images","archived":false,"fork":false,"pushed_at":"2022-05-07T01:35:26.000Z","size":101,"stargazers_count":2,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-26T23:03:44.644Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Rust","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/kellpossible.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2019-11-16T13:55:39.000Z","updated_at":"2022-05-07T01:35:29.000Z","dependencies_parsed_at":"2022-08-08T14:30:22.657Z","dependency_job_id":null,"html_url":"https://github.com/kellpossible/photo-captioner","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kellpossible%2Fphoto-captioner","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kellpossible%2Fphoto-captioner/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kellpossible%2Fphoto-captioner/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kellpossible%2Fphoto-captioner/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kellpossible","download_url":"https://codeload.github.com/kellpossible/photo-captioner/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248473121,"owners_count":21109629,"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":[],"created_at":"2024-10-14T18:47:51.115Z","updated_at":"2025-04-13T06:27:28.418Z","avatar_url":"https://github.com/kellpossible.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# photo-captioner [![crates io badge](https://img.shields.io/crates/v/photo-captioner.svg)](https://crates.io/crates/photo-captioner) [![license badge](https://img.shields.io/github/license/kellpossible/photo-captioner)](https://github.com/kellpossible/photo-captioner/blob/master/LICENSE.txt)\n\nThis is a command line application to aid in the creation and editing of captions for a gallery of images.\n\n![edit menu screenshot](screenshots/edit_menu.png)\n\nInstall:\n\n```bash\ncargo install photo-captioner\n```\n\nCommand Line Options:\n\n```txt\nUSAGE:\n    photo-captioner [FLAGS] [OPTIONS] [--] [gallery-dir]\n\nFLAGS:\n    -e, --edit       whether or not to edit the captions\n    -h, --help       Prints help information\n    -V, --version    Prints version information\n\nOPTIONS:\n    -n, --output-name \u003coutput-name\u003e\n            The name of the output file (if there is one). Will be \"captions.csv\" by default for the \"csv\" output-type.\n\n    -t, --output-type \u003coutput-type\u003e                   The type of output, available options: \"csv\" [default: csv]\n    -c, --view-command \u003cview-command\u003e\n            The command used to launch an image viewer upon editing the caption for an image in order to view the image\n            who's caption is being edited\n    -a, --view-command-args \u003cview-command-args\u003e...\n            The command used to launch an image viewer upon editing the caption for an image in order to view the image\n            who's caption is being edited. Escape dash \"-\" symbols with a backslash: \"\\-\". For example: -a \"\\-\\-some\"\n            \"command\"\n\nARGS:\n    \u003cgallery-dir\u003e    Directory of the gallery to generate captions for\n```\n\nCSV output file:\n\n```csv\nImage,Caption\nimage_filename.jpg,caption\n```\n\n## Building on Windows\n\nBuilding on Windows currently requires you to select a [different backend](https://github.com/gyscos/cursive/wiki/Backends) for the [cursive](https://github.com/gyscos/cursive) library. Target specific default features doesn't appear to be well supported in cargo/rust at the moment.\n\nYou have a few choices, but the one with the least effort required to setup is the [crossterm](https://github.com/crossterm-rs/crossterm) library. To select this for building use the command:\n\n```sh\ncargo build --no-default-features --features crossterm-backend --release\n```\n\n## Example\n\nUsing the [feh](https://feh.finalrewind.org/) image viewer to preview images while editing captions, and scale them nicely to fit the screen.\n\n```bash\nphoto-captioner -e -c \"feh\" -a \"\\-\\-scale-down\" \"\\-B\" \"black\" -- /photo/gallery/path\n```\n\nUsing Windows Explorer image viewer on Windows to preview images:\n\n```bash\nphoto-captioner -e -c \"explorer.exe\" -- /photo/gallery/path\n```\n\n## Features\n\nFeatures available are ticked, todo items remain unchecked until completed.\n\n- [x] generate captions.csv file in gallery directory\n- [x] gui (terminal ui) editor for editing captions\n- [x] update captions.csv with new images\n- [ ] write/read to jpg exif\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkellpossible%2Fphoto-captioner","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkellpossible%2Fphoto-captioner","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkellpossible%2Fphoto-captioner/lists"}