Merge pull request #5 from Tracks12/dev

doc(global): add contrubiting rules & code policy & add string docume…

Author: Tracks12

CONTRIBUTING.md

@@ -0,0 +1,109 @@
+# CONTRIBUTING
+
+## Coding Guidelines – toolsManager.py
+
+This document defines the best development practices to follow when contributing to the project.
+
+---
+
+### 📁 Project Structure
+
+- `main.py`: Main entry point.
+- `setup.py`: Installer for project-specific dependencies (`.rar` file).
+- `core/`: Contains the core modules (configuration, tool management, etc.).
+- `tools/`: Contains each tool, 1 `.py` file per tool.
+- `dev`: Continuous development branch.
+- `master`: Stable branch only.
+
+---
+
+### 🧱 Tool Writing Convention
+
+- Each tool must:
+	- be in a separate file under tools/,
+	- have the same name as the class (in PascalCase),
+	- inherit from core.tool.Tool,
+	- must implement the run() method.
+
+- Inheriting from Tool ensures consistent behavior and facilitates the overall management of tool modules.
+
+#### ✅ Minimum valid example:
+
+```python
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+# tools/hello.py
+
+from core.tool import Tool
+
+class Hello(Tool):
+	""" Say hello to the user
+	"""
+
+	command	= (("hello", "hel"), "(hel)lo")
+	name	= "Hello"
+	path	= __file__
+	version	= "0.1a"
+
+	def __init__(self, args: list[str]):
+		super().__init__()
+
+		self._args	= [
+			(("-s", "--say-hello", "<user>"), "Say hello to the user")
+		] + self._args[:]
+
+		self._execs = [
+			lambda x:self._sayHello(x)
+		] + self._execs[:]
+
+		self._run(args)
+
+	def _sayHello(user: str) -> bool:
+		print(f"Hello {user} ! :D")
+		return(True)
+```
+
+#### 🚨 Non-compliant example:
+
+```python
+# tools/hello.py
+
+# ❌ Missing inheritance from Tool
+class Hello:
+    def run(self):
+        ...
+```
+
+## 🧪 Tests
+
+- Tests are currently manual.
+- Adding a tool must be followed by a test in main.py or CLI.
+- Errors must be handled properly via try/except.
+
+## 🧰 Coding Conventions
+
+- Follow PEP8 conventions.
+- Strong typing is recommended (str, bool, etc.).
+- Each public method must have a clear docstring. - Preferred use of logging over print() (if applicable).
+
+## 🔁 GitFlow
+
+- Each new tool or feature must start from a dedicated branch from dev.
+- Branches must be named feature/tool-name or fix/issue.
+- Always rebase before merging to dev.
+- The master branch should only receive tested and stable code.
+- Each merge to master must be accompanied by a versioned tag (v1.2.0, etc.).
+
+## 🚀 Release
+
+- When merging to master, add a Git tag and a GitHub release if possible.
+- Releases must contain:
+	- a brief changelog,
+	- a list of added/modified tools,
+	- a version number.
+
+## 🤝 Contribution
+
+- Forks, pull requests, and issues welcome.
+- Please respect the structure and naming, and keep the code readable.

core/__init__.py

@@ -10,7 +10,7 @@
 	Constants:
 	- INFO: Contains application information such as version, git commit hash, and other metadata.
 	- REGEX_ARGS: A regular expression pattern used to parse and split argument strings into lists.
-	- UNITS: Units of measurement for bytes, including KB, MB, GB, TB, etc., to facilitate size conversions.
+	- UNITS: Units of measurement for bytes, including b, Kb, Mb, Gb, Tb, etc., to facilitate size conversions.
 
 """
 
@@ -28,9 +28,16 @@
 	"name": "toolsManager.py",
 	"version": "0.1",
 })
+""" Contains application information such as version, git commit hash, and other metadata
+"""
+
+REGEX_ARGS = str("\\s(?=(?:[^\"'`]*[\"'`][^\"'`]*[\"'`])*[^\"'`]*$)")
+""" A regular expression pattern used to parse and split argument strings into lists
+"""
 
-REGEX_ARGS	= str("\\s(?=(?:[^\"'`]*[\"'`][^\"'`]*[\"'`])*[^\"'`]*$)")
-UNITS		= tuple[str](("o", "ko", "Mo", "Go", "To"))
+UNITS = tuple[str](("b", "Kb", "Mb", "Gb", "Tb"))
+""" Units of measurement for bytes, including b, Kb, Mb, Gb, Tb, etc., to facilitate size conversions
+"""
 
 def helper(commands: tuple) -> None:
 	colors	= tuple[str]((Colors.cyan, Colors.yellow, Colors.red))

core/config.py

@@ -7,6 +7,9 @@
 	for the proper operation of tools. It supports various configuration formats and allows centralized
 	management of settings.
 
+	Constants:
+	- ACCEPT_ENCODING: Contains application encoding, including "ascii", "utf-8", "utf-16", "utf-32".
+
 """
 
 from json import JSONDecodeError, dump, load
@@ -16,6 +19,8 @@
 from core.icons import Icons
 
 ACCEPT_ENCODING	: tuple[str] = ("ascii", "utf-8", "utf-16", "utf-32")
+""" Contains application encoding, including "ascii", "utf-8", "utf-16", "utf-32"
+"""
 
 class Config:
 	""" Configuration manager object for the program.
@@ -34,6 +39,7 @@ class Config:
 			__splash (bool): Whether the splash screen is enabled at startup.
 
 		Methods:
+
 			getColors() -> bool:
 				Returns the current state of CLI color output.
 
@@ -53,8 +59,8 @@ class Config:
 				Updates the splash screen setting and saves the configuration.
 
 		Notes:
-			- The configuration file must be in JSON format with the keys: "colors", "encoding", and "splash".
-			- Accepted encodings are defined in the module-level constant `ACCEPT_ENCODING`.
+		- The configuration file must be in JSON format with the keys: "colors", "encoding", and "splash".
+		- Accepted encodings are defined in the module-level constant `ACCEPT_ENCODING`.
 
 	"""