Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mboljen/photocopy

Copy or move JPEG images from one location to another
https://github.com/mboljen/photocopy

perl-script perlmagick

Last synced: about 2 months ago
JSON representation

Copy or move JPEG images from one location to another

Host: GitHub
URL: https://github.com/mboljen/photocopy
Owner: mboljen
License: mit
Created: 2021-01-24T14:27:21.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2024-07-02T17:54:28.000Z (6 months ago)
Last Synced: 2024-10-13T11:43:03.687Z (3 months ago)
Topics: perl-script, perlmagick
Language: Perl
Homepage:
Size: 19.5 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: COPYING

Awesome Lists containing this project

README

# Photocopy

Copies or moves JPEG images from one location to another

## Synopsis

```console
$ photocopy [OPTION]...
```

The script can be invoked using zero, one or two arguments.

+ If it is invoked using *two* arguments, the first argument holds the source directory _srcdir_ and the second argument holds the output directory _outdir_.

+ If it is invoked using *one* argument and this argument is an existing *directory*, it is assigned as output directory _outdir_. The current working directory is assumed to be the source directory _srcdir_.

+ If it is invoked using *one* argument and this argument is an existing *file*, it is used as configuration file containing options as key-value-pairs. Additional command line options will override the settings in the configuration file.

+ If it is invoked using *one* argument and this argument is a *string*, it is used as a basename for a configuration file with the file extension `.rc`. This file needs to reside in the directory `~/.photocopy`. Additional command line options will override the settings in the configuration file.

## Description

The script `photocopy` transfers JPEG images from the source directory _srcdir_ to the output directory _outdir_. Image files can be *copied*, *moved* or *converted*.

The script can be used to transfer images from a photo camera to a local image repository or to upload the most recent images from a local image repository to a remote location. For the latter, `photocopy` can be configured to automatically remove images from the remote location that exceed a certain threshold.

Files at the output location will be renamed to a unique filename based upon the EXIF original timestamp of the source file.

### Warning

It is recommended to reserve the output directory _outdir_ exclusively for `photocopy` and not to use it for any other purpose, especially when the option **limitmode** is enabled. If the latter is true, unregistered files in _outdir_ matching the same file extension will be removed. It is recommended to enable **dryrun** to see what would happen.

## Options

+ `--srcdir` = _folder_

Specify the name of the source directory. The source directory must exist and the user must have read permission.

+ `--outdir` = _folder_

Specify the name of the output directory. The output directory must exist and the user must have write permission.

+ `--action` = _string_

Specify the transfer action. Valid values are `cp` for copying, `mv` for moving and `cv` for converting.

+ `--cachefile` = _filename_

Specify the name of the cachefile.

+ `--cvopt` = _string_

Add ImageMagick options when **action** is `cv` for converting.

+ `--dirdepth` = _integer_

Set number of subfolders within directory _outdir_. Valid values are `1`, `2` and `3`.

+ `--dirfmt1` | `--dirfmt2` | `--dirfmt3` = _string_

Use `strftime` flags to label subfolders in directory _outdir_. The default setting is `%Y` for subfolder 1, `%m` for subfolder 2 and `%d` for subfolder 3.

+ `--limitmode` = _string_

Activate flag to limit files at directory _outdir_. Use `none` (default) to disable this option. If set, this option requires **limitcount** being set to a positive value. The following modes are available:

- `num`

Limit the number of image files to the most recent ones.

- `date`

Remove images when their EXIF datetime is older than a certain amount of days from today.

- `uptime`

Remove images after a certain amount of days of being uploaded.

+ `--limitcount` = _integer_

Add threshold value for **limitmode**. The default is `0`.

+ `--outext` = _string_

Specify the format of the images at the output directory. The default is `JPG`.

+ `--recurse`

Recurse into all subfolders of the source directory.

+ `--dryrun`

Do not change the file system. Only simulate what would be done.

+ `--progress`

Enable or disable the use of a progress bar. Default is enabled.

+ `--help`

Print a brief help message and exit.

## Requirements

+ [Date::Parse](https://metacpan.org/pod/Date::Parse)
+ [File::HomeDir](https://metacpan.org/pod/File::HomeDir)
+ [File::Slurp](https://metacpan.org/pod/File::Slurp)
+ [Image::Magick](https://metacpan.org/pod/Image::Magick)
+ [Regexp::Common](https://metacpan.org/pod/Regexp::Common)

## Installation

Use the following command to install this software:

```console
$ make
$ make install
```

The default `PREFIX` is set to `/usr/local`. In order to successfully complete the installation, you need to have write permissions for the installation location.

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License

[MIT](https://choosealicense.com/licenses/mit/)