Connor is a file organizer written in Python. It makes use of the sentence-transformers framework for the main organization process and the PyQt6 GUI toolkit for the graphical user interface. It is by no means supposed to substitute for organzing files by hand. It is just a concept. Connor features a fast and fully local file organizer that uses natural language processing to organize computer files based on their textual content.

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.

User Preferences

Command Line Interface: Quick folder organization.
Graphical Interface: Simple GUI with file upload support.

Installation

There are installation instructions for both GUI and CLI. You can choose the one you want to install. If you're opting for building the application from source then adding the run file to path is recommended.

Install Connor via pip:

1. Make sure you have python and pip installed and added to path.
2. Run pip install connor-nlp

Install the GUI version of Connor (executable)

1. Go to the latest release.
2. Follow the steps there.
3. Run the executable (.exe).

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)
• -t, --similarity-threshold: Define the similarity threshold percentage. (default: 50)
• --show: Show current settings

Example:

connor settings -f 2 -r 150 -t 60

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

Current settings:
  folder words limit     3
  reading limit          200
  similarity threshold   50%

--gui: Run Connor as a full fledged GUI from the terminal.

Usage:

connor --gui

Help

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

Example:

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

Connor: Fast and local NLP file organizer

positional arguments:
  {settings,run}
    settings      Update the settings for the organizer
    run           Run the folder organization process

options:
  -h, --help      show this help message and exit
  --gui           Run the application in GUI mode.

Source

1. Clone repository:

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

2. Create and activate virtual environment:

python3 -m venv venv
source venv/bin/activate

3. Install dependencies:

pip3 install -r requirements.txt

4. Run program:

For GUI:

python3 run.py --gui

For CLI:

python3 run.py -h

5. Install locally (optional):

pip3 install .

Example:

connor --gui

connor -h

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.