ftagger 0.1.0__py3-none-any.whl

ansi_codes.py

@@ -0,0 +1,9 @@
+red = "\033[31m"
+green = "\033[32m"
+yellow = "\033[33m"
+blue = "\033[34m"
+purple = "\033[35m"
+cyan = "\033[36m"
+clear = "\033[0m"
+underline = "\033[4m"
+bold = "\033[1m"

commands.py

@@ -0,0 +1,273 @@
+import os
+import json
+import globals
+
+
+from pathlib import Path
+from utils import *
+
+
+def help() -> None:
+    info(
+        "|   Name   |                   Description                    |           Usage               |",
+        "|---------------------------------------------------------------------------------------------|",
+        "|    at    |    adds a tag to file or folder                  |    at <path> <tag>            |",
+        "|    rt    |    removes a tag from file or folder             |    rt <path> <tag>            |",
+        "|    gi    |    gets items by tag                             |    gi <path> <tag>            |",
+        "|    gt    |    gets tags of a file or folder                 |    gt <path>                  |",
+        "|    li    |    lists files and folders and their tags        |    li <path>                  |",
+        "|    rc    |    tags all items in a directory                 |    rc <path> <tag> <depth>    |",
+        "|    rr    |    removes a tag from all items in a directory   |    rr <path> <tag> <depth>    |",
+        "|    ca    |    creates an alias for a command                |    ca <command> <alias>       |",
+        "|    ra    |    removes an alias                              |    ra <alias>                 |",
+        "|    la    |    lists all existing aliases                    |    la                         |",
+        "|    rd    |    resets all alias data                         |    rd                         |",
+    )
+
+
+def add_tag(path: str, tag: str) -> None:
+    tag: bytes = tag.encode('utf-8')
+
+
+    try:
+        current_tag: bytes = os.getxattr(path=path, attribute=b"user.tags")
+    except:
+        current_tag = "".encode('utf-8')
+
+
+    if current_tag != b'': 
+        combined_tag: bytes = current_tag + ",".encode('utf-8') + tag
+    else:
+        combined_tag: bytes = tag
+
+    
+    os.setxattr(path=path, attribute=b"user.tags", value=combined_tag)
+
+
+def remove_tag(path: str, tag: str) -> None:
+    tag: bytes = tag.encode('utf-8')
+
+
+    values: list[str] = os.getxattr(path=path, attribute=b"user.tags").decode('utf-8').split(",")
+    values.remove(tag.decode('utf-8'))
+    values = ",".join(values).encode('utf-8')
+
+    os.setxattr(path=path, attribute=b"user.tags", value=values)
+
+
+def get_items_by_tag(path: str, value: str) -> None:
+    for item in Path(path).rglob("*"):
+        try:
+            tags = os.getxattr(path=item, attribute=b"user.tags").decode('utf-8').split(",")
+        
+        except:
+            tags = []
+
+
+        if value in tags:
+            if os.path.isdir(item):
+                print(f"{ac.blue}{item}{ac.clear}")
+
+            else:
+                print(item)
+
+
+def get_tags(path: str) -> None:
+    try:
+        tags = os.getxattr(path=path, attribute=b"user.tags").decode('utf-8')
+
+        tags = tags.split(",")
+
+    except:
+        tags = ["~"]
+
+    for i in tags:
+        if tags == []:
+            print("~")
+        else:
+            print(i)
+
+
+def list_items_and_tags(path: str) -> None:
+    for item in Path(path).rglob("*"):
+        try:
+            tags = os.getxattr(path=item, attribute=b"user.tags").decode('utf-8')
+        except:
+            tags = ""
+
+        if os.path.isdir(item):
+            print(f"{ac.blue}{ac.bold}{str(item): <30}{ac.clear}{tags: >15}")
+        else:   
+            print(f"{str(item): <30}{tags: >15}")
+
+
+def recursive_add_tag(path: str, tag: str, depth: int) -> None:
+    depth = int(depth)
+
+    for item in Path(path).rglob("*"):
+        if len(str(item).split("/")) <= depth:
+            add_tag(item, tag=tag)
+
+
+def recursive_remove_tag(path: str, tag: str, depth: int) -> None:
+    depth = int(depth)
+
+    for item in Path(path).rglob("*"):
+        if len(str(item).split("/")) <= depth:
+            try:
+                remove_tag(item, tag)
+            except:
+                print(f"Item {item} doesn't have tag {tag}")
+
+
+def create_alias(command: str, alias: str) -> None:
+    with open(globals.FMDEFAULT, "r") as file:
+        try:
+            commands_dict: dict = json.load(file)
+        except:
+            commands_dict: dict = {}
+
+
+        with open(globals.FMALIASLOOKUP, "r") as fm_alias_lookup_file, open(globals.FMALIASES, "r") as fm_alias_file:
+            try:
+                lookup_dict: dict = json.load(fm_alias_lookup_file)
+            except:
+                lookup_dict: dict = {}
+
+
+            try:
+                alias_dict: dict = json.load(fm_alias_file)
+            except:
+                alias_dict: dict = {}
+
+
+            lookup_dict.update({ alias: command })
+            alias_dict.update({ alias: commands_dict[command] })
+
+
+        with open(globals.FMALIASLOOKUP, "w") as fm_alias_lookup_file, open(globals.FMALIASES, "w") as fm_alias_file:
+            json.dump(lookup_dict, fm_alias_lookup_file, indent=4)
+            json.dump(alias_dict, fm_alias_file, indent=4)
+
+
+    with open(globals.FMUNDOLOOKUP, "r") as file:
+        undo_dict = json.load(file)
+
+        undo_dict.update({ alias: undo_dict[command] })
+
+
+    with open(globals.FMUNDOLOOKUP, "w") as file:
+        json.dump(undo_dict, file, indent=4)
+
+
+def remove_alias(alias: str) -> None:
+    with open(globals.FMALIASLOOKUP, "r") as fm_alias_lookup_file, open(globals.FMALIASES, "r") as fm_aliases_file:
+        try:
+            alias_dict: dict = json.load(fm_aliases_file)
+            lookup_dict: dict = json.load(fm_alias_lookup_file)
+        except:
+            alias_dict: dict = {}
+            lookup_dict: dict = {}
+            error("Please use the 'rd' command and re-add your aliases")
+
+
+        try:
+            lookup_dict.pop(alias)
+            alias_dict.pop(alias)
+        except:
+            error("Alias does not exist")
+            return
+
+
+    with open(globals.FMALIASLOOKUP, "w") as fm_alias_lookup_file, open(globals.FMALIASES, "w") as fm_aliases_file:
+        try:
+            json.dump(lookup_dict, fm_alias_lookup_file, indent=4)
+            json.dump(alias_dict, fm_aliases_file, indent=4)
+        except:
+            json.dump({}, fm_alias_lookup_file, indent=4)
+            json.dump({}, fm_aliases_file, indent=4)
+
+
+    with open(globals.FMUNDOLOOKUP, "r") as file:
+        undo_dict = json.load(file)
+
+        undo_dict.pop(alias)
+
+
+    with open(globals.FMUNDOLOOKUP, "w") as file:
+        json.dump(undo_dict, file, indent=4)
+        
+
+def list_aliases() -> None:
+    with open(globals.FMALIASLOOKUP, "r") as file:
+        aliases: dict = json.load(file)
+
+        for key, value in aliases.items():
+            print(f"{key}: {value}")
+
+
+def reset_data() -> None:
+    with open(globals.FMALIASLOOKUP, "w") as file:
+        json.dump({}, file, indent=4)
+
+
+    with open(globals.FMALIASES, "w") as file:
+        json.dump({}, file, indent=4)
+
+
+    with open(globals.FMDEFAULT, "w") as file:
+        default_data: dict = {
+            "--help": "help",
+            "at": "add_tag",
+            "rt": "remove_tag",
+            "gi": "get_items_by_tag",
+            "gt": "get_tags",
+            "li": "list_items_and_tags",
+            "rc": "recursive_add_tag",
+            "rr": "recursive_remove_tag",
+            "ca": "create_alias",
+            "ra": "remove_alias",
+            "la": "list_aliases",
+            "rd": "reset_data",
+            "un": "undo"
+        }
+
+        json.dump(default_data, file, indent=4)
+
+
+    with open(globals.FMUNDOLOOKUP) as file:
+        default_data: dict = {
+            "at": "rt",
+            "rt": "at",
+            "rc": "rr",
+            "rr": "rc",
+            "ca": "ra",
+            "ra": "ca",
+            "tag": "rt"
+        }
+
+
+    with open(globals.FMPREVIOUSCOMMAND, "w") as file:
+        default_data: dict = {
+            "0": [
+                "/home/charlie/.local/bin/fm",
+                "la"
+            ],
+            "1": [
+                "/home/charlie/.local/bin/fm",
+                "undo"
+            ],
+            "2": [
+                "/home/charlie/.local/bin/fm",
+                "efdsfs"
+            ],
+            "3": [
+                "/home/charlie/.local/bin/fm",
+                "efdsfs"
+            ],
+            "4": [
+                "/home/charlie/Projects/fm/.venv/bin/fm",
+                "rd"
+            ]
+        }
+

ftagger-0.1.0.dist-info/METADATA

@@ -0,0 +1,116 @@
+Metadata-Version: 2.4
+Name: ftagger
+Version: 0.1.0
+Summary: Simple command-line file tagger
+Author-email: Charlie O'Dwyer <charlieodwyer2289@gmail.com>
+License-Expression: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: POSIX :: Linux
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Dynamic: license-file
+
+# Preface
+
+Most of this project was created before I began using GitHub, which is why the first commit is alreadyalmost finished..
+
+I have yet to implement proper error handling, as well as a few commands.
+
+This is just a personal project that I will use for college. The goal is not for it to be perfect, but for it to work. 
+
+Any criticism is welcome — especially about my code. It is also worth noting that this is the first documentation I've written, so I apologise if it's not up to your expected standard. Please also tell me how I can improve the docs. Thank you. 
+
+This programme has only been tested on Linux. Due to its use of the 'os' module and extended attributes, it may not work on all operating systems.
+
+
+# What Is This Project?
+
+This project is a very simple command-line file tagger. Its main function is to tag files and folders to make organisiation easier. I wrote this programme, as I am going to start college soon, and I wanted a simple way to organise my notes. It is just a personal project. Below is an outline of the features:
+
+- Tagging files and folders. The 'os' module is used to tag items using extended attributes. Command: at
+
+- Removing tags from files and folders. Command: rt
+
+- Searching for items in a directory with a given tag. Command: gi
+
+- Getting the tags of an item. Command: gt
+
+- Listing all items in a given directory, along with their tags. Command: li
+
+- Creating and removing aliases for commands. Commands: ca, ra
+
+- Listing all aliases. Command: la
+
+- Recursively adding tags to or removing tags from items to a certain depth. Commands: rc, rr
+
+- Resetting all dotfiles in ~/.fmdata (aliases, lookup tables, etc). Command: rd
+
+- Undo. Undo the previous undoable command, up to five commands ago.
+
+
+# Help
+
+Here is the output of running the command with the --help flag:
+
+```
+|   Name   |                   Description                    |           Usage               |
+|---------------------------------------------------------------------------------------------|
+|    at    |    adds a tag to a file or folder                |    at <path> <tag>            |
+|    rt    |    removes a tag from file or folder             |    rt <path> <tag>            |
+|    gi    |    searches items by tag                         |    gi <path> <tag>            |
+|    gt    |    displays tags of a file or folder             |    gt <path>                  |
+|    li    |    lists files and folders and their tags        |    li <path>                  |
+|    rc    |    tags all items in a directory                 |    rc <path> <tag> <depth>    |
+|    rr    |    removes a tag from all items in a directory   |    rr <path> <tag> <depth>    |
+|    ca    |    creates an alias for a command                |    ca <command> <alias>       |
+|    ra    |    removes an alias                              |    ra <alias>                 |
+|    la    |    lists all existing aliases                    |    la                         |
+|    rd    |    resets all alias data                         |    rd                         |
+```
+
+
+# Installation and Uninstallation
+### To install
+```
+pip install ftagger
+
+OR
+
+pipx install ftagger
+```
+
+### To uninstall
+```
+pip uninstall ftagger
+
+OR
+
+pipx uninstall ftagger
+```
+
+
+# Usage
+After installation, you should be able to run the programme from a terminal. Here is an example of what that may look like:
+```
+fm at file1.txt tag
+```
+
+Here is a breakdown of that example command:
+    fm — the command used to invoke this programme. It is like cd, ls, cat, etc
+    at — the 'add tag' command
+    file1.txt — the target. This can be a file or a folder
+    tag — the tag to add to the target
+
+To get help about the usage of the commands, run the following command:
+```
+fm --help
+```
+
+This will print out the table seen under the 'Help' heading. 
+
+
+# Requierments
+Python 3.10 and above
+
+The project has only been tested on Linux

ftagger-0.1.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ansi_codes.py,sha256=dBGMLdyjepkcBPSdmCw_TjT-4m_YuzwSDryN0GOe5_E,169
+commands.py,sha256=NtHOJALHSwG_80CyHXcZNAJfuZmhJa_RE2uVU88y_Ko,8224
+globals.py,sha256=QaKYnWGtLEdiEK3u0bdqkPGN7DytgUFaRvsSPS02KM0,295
+main.py,sha256=wnF4oycYfWQPFGOcsE-t-UE_cwFreQhr1f27WK0bKb0,2455
+utils.py,sha256=10Vf_Eydh9zyPUaHX6OdsH8KnO6xxETwss-PW8-3mE4,240
+ftagger-0.1.0.dist-info/licenses/LICENSE.txt,sha256=H4Cfdy1mdP1us0n8OA3DGmwDrSGG-PoThIksgkTpgsc,1079
+ftagger-0.1.0.dist-info/METADATA,sha256=ocLF2PaAITnNnk5u0hLVPTDFXN8qPwdECol8UeO0CIc,4313
+ftagger-0.1.0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+ftagger-0.1.0.dist-info/entry_points.txt,sha256=cYxon2VJIR8jxPUQkZ7z1_ntCHmxgUJ2spSuJNGoXbs,33
+ftagger-0.1.0.dist-info/top_level.txt,sha256=AwOSfLiYP-tbNt70pEfhTDWoBi99idIF-fkc3kjw20w,48
+ftagger-0.1.0.dist-info/RECORD,,

ftagger-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (83.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

ftagger-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+fm = main:main

ftagger-0.1.0.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,9 @@
+MIT license
+
+Copyright (c) 2026 Charlie O'Dwyer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

ftagger-0.1.0.dist-info/top_level.txt

@@ -0,0 +1,6 @@
+__init__
+ansi_codes
+commands
+globals
+main
+utils

globals.py

@@ -0,0 +1,7 @@
+from pathlib import Path
+
+FMDEFAULT = f"{Path.home()}/.fmdata/.fmdefault"
+FMALIASES = f"{Path.home()}/.fmdata/.fmaliases"
+FMALIASLOOKUP = f"{Path.home()}/.fmdata/.fmaliaslookup"
+FMUNDOLOOKUP = f"{Path.home()}/.fmdata/.fmundolookup"
+FMPREVIOUSCOMMAND = f"{Path.home()}/.fmdata/.fmpreviouscommand"

main.py

@@ -0,0 +1,95 @@
+import commands
+import json
+import globals
+
+from sys import argv, modules
+from utils import *
+
+
+def call(args: list[str]) -> None:
+    with open(globals.FMDEFAULT, "r") as file:
+        commands_dict: dict = json.load(file)
+
+    with open(globals.FMALIASES, "r") as f:
+        alias_dict: dict = json.load(f)
+
+        try:
+            commands_dict.update(alias_dict)
+        except:
+            pass
+
+
+    for key, value in commands_dict.items():
+        try:
+            commands_dict[key] = getattr(commands, value)
+        except:
+            try:
+                commands_dict[key] = getattr(modules[__name__], value)
+            except:
+                debug(commands_dict)
+                error(f"There may be an invalid alias. Please check the aliases you've added: {key}: {value}")
+
+
+    try:
+        match len(args):
+            case 2:
+                commands_dict[args[1]]()
+
+            case 3:
+                commands_dict[args[1]](args[2])
+                
+            case 4:
+                commands_dict[args[1]](args[2], args[3])
+
+            case 5:
+                commands_dict[args[1]](args[2], args[3], args[4])
+
+    except Exception:
+        debug("Error handling is not yet fully implemented, as I have decided to change how to impement it. For debugging purposes, the exception will now be raised.")
+        raise Exception
+        
+
+
+def undo() -> None:
+    with open(globals.FMPREVIOUSCOMMAND, "r") as file:
+        previous_commands: list[str] = json.load(file)
+
+
+        with open(globals.FMUNDOLOOKUP, "r") as f:
+            undo_dict: dict = json.load(f)
+
+            
+            for command in list(previous_commands.values())[::-1]:
+                debug(command)
+                try:
+                    command[1] = undo_dict[command[1]]
+                    call(command)
+                except:
+                    pass
+
+
+def main() -> None:
+    command: list[str] = argv
+
+
+    with open(globals.FMPREVIOUSCOMMAND, "r") as file:
+        previous_commands: dict = json.load(file)
+        
+        previous_commands.update({
+            "0": previous_commands["1"],
+            "1": previous_commands["2"],
+            "2": previous_commands["3"],
+            "3": previous_commands["4"],
+            "4": command,
+        })
+        
+
+    with open(globals.FMPREVIOUSCOMMAND, "w") as file:
+        json.dump(previous_commands, file, indent=4)
+
+
+    call(command)
+
+            
+if __name__ == "__main__":
+    main()

utils.py

@@ -0,0 +1,13 @@
+import ansi_codes as ac
+
+def error(text: str) -> None:
+    print(f"{ac.red}{text}{ac.clear}")
+
+
+def debug(text: str) -> None:
+    print(f"{ac.green}{text}{ac.clear}")
+
+
+def info(*text: str) -> None:
+    for line in text:
+        print(line)