hypertag 0.1.2

File organization made easy using tags

HyperTag

File organization made easy. HyperTag let's humans intuitively express how they think about their files using tags.

Install

Currently there is no easy install available. Gotta clone this repo.

Install packages: $ python -m pip install fire tqdm filetype

Setup alias: alias hypertag='python your/clone/path/hypertag/hypertag/hypertag.py'

Quickstart

HyperTag offers a slick CLI but more importantly it creates a directory called HyperTagFS which is a file system based representation of your files and tags using symbolic links and directories. HyperTag recognizes a multitude of file types and groups them automatically together into folders, which can be found in HyperTagFS.

CLI Functions

Set HyperTagFS directory path

Default is the user's home directory.

$ hypertag set_hypertagfs_dir path/to/directory

Import existing directory recursively

Import files with tags inferred from existing directory hierarchy

$ hypertag import path/to/directory

Tag file/s

Manually tag files

$ hypertag tag humans/*.txt with human "Homo Sapiens"

Tag a tag

Metatag tag/s to create tag hierarchies

$ hypertag metatag human with animal

Merge tags

Merges all associations (files & tags) of tag_a into tag_b

$ hypertag merge human into "Homo Sapiens"

Query using Set Theory

Prints file names matching the query. Nesting is currently not supported, queries are evaluated from left to right.

Default operand is AND (intersection):
$ hypertag query human "Homo Sapiens"

OR (union):
$ hypertag query human or "Homo Sapiens"

MINUS (difference):
$ hypertag query human minus "Homo Sapiens"

Print all tags

$ hypertag show

Print all files

$ hypertag show files

Architecture

• Python 3.9 powers HyperTag
• SQLite3 serves as the meta data storage engine
• Symbolic links are used to create the HyperTagFS directory structure

Inspiration

This project is inspired by other existing open-source projects:

• TMSU
• SuperTag

What is the point of HyperTag's existence? HyperTag offers some unique features such as the import function that make it very convenient to use. Also HyperTag's code base is written in Python and thus extremely small (<500 LOC) compared to TMSU (>10,000 LOC) and SuperTag (>25,000 LOC), making it very easy to modify / extend / fix it yourself.