21 lines
958 B
Markdown
21 lines
958 B
Markdown
# image-index
|
|
This project is a collection of scripts which can index and sort files on your pc. You can give every file a title, category, source, tags and content for easier finding later on.
|
|
|
|
## Installation
|
|
```sh
|
|
git clone https://gitlab.com/rodin_schule/image-index-py.git
|
|
cd ./image-index-py
|
|
cp config-def.py config.py
|
|
```
|
|
|
|
## Functions
|
|
* add - Add a file and entry to the index
|
|
* search - search through the index
|
|
* delete - delete a file and remove the entry
|
|
* update - change a value of an entry in the index or move a file to another category
|
|
|
|
* check - check if all files in the index exist and have the correct hash
|
|
## Configuration
|
|
The file `config.py` holds some very important variables which you need to look at before using the index:
|
|
* ROOT_DIR: The absolute path of where you want to save your files (the directories for the categories will be created there)
|
|
* CONFIG_DIR: The absolute path of where you want to store your `index.db`-file. |