Connor is a fast and fully local file classifier and organizer. It is written in Python and makes use of the sentence-transformers framework for the main organization process. It is by no means supposed to substitute for organzing files by hand. It is just a concept

demo.mp4

Features

Connor runs locally using the sentence-transformers/paraphrase-MiniLM-L6-v2 model to analyze file content and organize them based on semantic similarity. It uses cosine similarity to group similar files and applies Latent Dirichlet Allocation (LDA) to name folders.

Unprocessable files (e.g., images, binaries) are sorted into a _misc folder based on their extensions.

Customization Options

1. Similarity Threshold: Set the minimum similarity percentage threshold for grouping.
2. Reading Word Limit: Limit how much of a file is read.
3. Folder Name Word Limit: Set max words for folder names.

Installation

1. Clone repository:

git clone https://github.com/ycatsh/connor.git
cd connor

2. Create and activate virtual environment:

Linux:

python3 -m venv .venv
source .venv/bin/activate

Windows:

python -m venv .venv
.venv/bin/activate.bat

3. Install dependencies:

pip install -r requirements.txt

4. Run program:

python src/connor/main.py -h

5. Install locally (optional):

pip install .

Example:

connor -h

Usage

Command Structure

connor [command] [options]

Commands

run: Run the folder organization process.

Usage:

connor run <folder_path>

Options:

• folder_path: Required. Absolute path to the folder that you want to organize.

Example:

connor run /path/to/your/folder

settings: Update the default settings for the tool.

Usage:

connor settings [options]

Options:

• -f, --folder-word-limit: Set the maximum length for folder names. (default: 3)
• -r, --reading-limit: Specify the word limit for reading files. (default: 200)
• -s, --similarity-threshold: Define the similarity threshold percentage. (default: 50)

Example:

$ connor settings -f 2 -r 150 -s 60
Settings updated successfully.

$ connor settings
To see how to update: Connor settings [-h]

Current settings:
  folder words limit     2
  reading limit          150
  similarity threshold   60%

Help

To view help information for commands and options use the -h or --help flag.

Example:

$ connor -h
usage: connor [-h] {settings,run} ...

Connor: Fast and local NLP file organizer

positional arguments:
  {settings,run}
    settings      View or update settings.
    run           Organize a folder.

options:
  -h, --help      show this help message and exit

License

This project is distributed under MIT License, which can be found in LICENSE in the root dir of the project. I reserve the right to place future versions of this project under a different license.