diff options
| author | Leonard Kugis <leonard@kug.is> | 2023-03-21 19:58:46 +0100 |
|---|---|---|
| committer | Leonard Kugis <leonard@kug.is> | 2023-03-21 19:58:46 +0100 |
| commit | b4372f1e683121c911eb0a3e8d504a7000a0498e (patch) | |
| tree | f5b59950e9b14f3938c798dfe8150abeba1b06d4 | |
| parent | b05c4000100be8effb3e458a1dfeea948c216ce6 (diff) | |
Added README
| -rw-r--r-- | README.md | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..87cb24f --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# file-tagger + +*file-tagger* is a tool for bulk-tagging files. +It uses the tagging system [TMSU](https://tmsu.org/) as backend. +For images, it uses tensorflow and ResNet50 to predict keywords automatically, +and comes with a GUI to fastly preview the image and add new tags. + +## Requirements + +- [TMSU](https://tmsu.org/) +- OpenCV (optional) +- Numpy (optional) +- tkinter (optional) +- tensorflow (optional) + +## Usage + +``` +usage: file-tagger.py [-h] [-b [BASE]] [-f [FILE_DIR]] [-g [GUI]] [--predict-images [PREDICT_IMAGES]] [--predict-images-top [PREDICT_IMAGES_TOP]] + [--gui-tag [GUI_TAG]] [--open-system [OPEN_SYSTEM]] [-i [INDEX]] [-v] + +Tag multiple files using TMSU. + +options: + -h, --help show this help message and exit + -b [BASE], --base [BASE] + Base directory with database (default: .) + -f [FILE_DIR], --file-dir [FILE_DIR] + File directory for walking (default: .) + -g [GUI], --gui [GUI] + Show main GUI (default: False) + --predict-images [PREDICT_IMAGES] + Use prediction for image tagging (default: False) + --predict-images-top [PREDICT_IMAGES_TOP] + Defines how many top prediction keywords should be used (default: 10) + --gui-tag [GUI_TAG] Show GUI for tagging (default: False) + --open-system [OPEN_SYSTEM] + Open all files with system default (default: False) + -i [INDEX], --index [INDEX] + Start tagging at the given file index (default: 0) + -v, --verbose Verbosity level +``` + +## Getting started + +1. Install requirements `pip install tensorflow numpy tkinter opencv-python` +2. Run the main script given the base directory `python file-tagger.py --base <base> --gui --gui-tag --predict-images` +3. Consecutively tag the files by entering comma-separated tags to the entry and pressing `Next` +4. If you want to take a break from tagging, remember the current index and give it as start index next time. Mind that adding/removing files will invalidate the index.
\ No newline at end of file |