cutyx

✨ Tool to organise your image gallery using machine learning. ✨

💫 CutyX

Tool to organise your image gallery using machine learning.

To get an overview how CutyX can be used, see the examples in the documentation.

A simple usage is shown below:

cutyx match faces /path/to/some/image.jpg albums/some-album
cutyx run

This will register similar faces as in image.jpg to be automatically sorted into the albums/some-album directory. The second command will do the actual sorting (copying or symlinking).

The source for this project is available here.

💿 Installation

To install it with pip run: pip install cutyx.

To install this package locally for development, clone it first using git clone https://github.com/leahevy/cutyx and run: pip install -e .[dev].

For installation of the latest version you can install it with pip directly from GitHub with the command: pip install git+https://github.com/leahevy/cutyx.git.

💡 Shell completion

For shell completion run one of the appropriate commands:

• cutyx --install-completion=bash
• cutyx --install-completion=zsh
• cutyx --install-completion=fish

⌨️ Commands

The following commands are available:

run

Process images anywhere in a directory hierarchy.

process-image

Process a single image

match

Group of commands to register matching conditions for album directories.

update-cache

Generates or updates the cache for processed images.

clear-cache

Clears the local cache.

📖 Documentation

The documentation is available at https://leahevy.github.io/cutyx.

👥 Contributing

Want to add a contribution to CutyX? Feel free to send a pull request.

See also here.

🎓 License

Copyright (C) 2022 Leah Lackner

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.