- Ruff formatter added and applied to the project

- Ruff linter and CONTRIBUTING.md added

Author: gitdevjin

.gitignore

@@ -160,5 +160,5 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
-
+.ruff_cache/
 reference.py

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "[python]": {
+        "editor.formatOnSave": true
+    },
+}

CONTRIBUTING.md

@@ -0,0 +1,24 @@
+## To set up automated Ruff linting and formatting with VS Code, Follow the instructions:
+
+### 1. Python Extension for VS Code (if not already installed):
+
+The Python extension for VS Code is needed to enable Python-specific features, such as linting and formatting integration. Open VS Code, go to the Extensions view (Ctrl+Shift+X or Cmd+Shift+X on macOS),search for "Python" by Microsoft and install it if you haven’t already.
+
+### 2. Ruff VS Code Extension:
+
+Install the Ruff extension in VS Code to enable real-time linting and formatting.
+In the Extensions view, search for "Ruff," and install the extension.
+
+## Manually Running Ruff Formatter and Linter
+
+### Run the `Ruff formatter` with the following command in the root directory
+
+```bash
+poetry run ruff format .
+```
+
+### Run the `Ruff Linter` with the following command in the root directory
+
+```bash
+poetry run ruff check .
+```

code_mage/api.py

@@ -2,42 +2,48 @@
 import sys
 from openai import OpenAI
 
+
 class Api:
-    def __init__(self, model, config):
-        self.supported_model = ["groq", "openrouter"]
-        self.model = model if model is not None else "openrouter"
-
-        if self.model not in self.supported_model:
-            sys.exit(f"{self.model} api model is not suppored. Model Supported: {self.supported_model}")
-        
-        # default api_url and api_model
-        self.api_url = "https://openrouter.ai/api/v1"
-        self.api_model = "sao10k/l3-euryale-70b"
-        self.api_key = os.getenv("OPENROUTER_API_KEY") or config.get('OPENROUTER_API_KEY')
-
-        # api_url and api_model when the provider is groq
-        if self.model is "groq":
-            self.api_url = "https://api.groq.com/openai/v1"
-            self.api_model = "llama3-8b-8192"
-            self.api_key = api_key = os.getenv("GROQ_API_KEY") or config.get('GROQ_API_KEY')
-
-
-    def call_api(self, target_lang, code, stream_flag = False):
-            
-        client = OpenAI(
-            base_url = self.api_url,
-            api_key = self.api_key,
-        )
-
-        completion = client.chat.completions.create(
-            extra_headers={
-                },
-            model=self.api_model,
-            messages=[
-                {"role": "system", "content": "only display the code without any explanation"},
-                {"role": "user", "content": f"translate this to {target_lang} language: {code}"},
-            ],
-            stream=stream_flag,
-        )
-
-        return completion
+	def __init__(self, model, config):
+		self.supported_model = ["groq", "openrouter"]
+		self.model = model if model is not None else "openrouter"
+
+		if self.model not in self.supported_model:
+			sys.exit(
+				f"{self.model} api model is not suppored. Model Supported: {self.supported_model}"
+			)
+
+		# default api_url and api_model
+		self.api_url = "https://openrouter.ai/api/v1"
+		self.api_model = "sao10k/l3-euryale-70b"
+		self.api_key = os.getenv("OPENROUTER_API_KEY") or config.get("OPENROUTER_API_KEY")
+
+		# api_url and api_model when the provider is groq
+		if self.model == "groq":
+			self.api_url = "https://api.groq.com/openai/v1"
+			self.api_model = "llama3-8b-8192"
+			self.api_key = os.getenv("GROQ_API_KEY") or config.get("GROQ_API_KEY")
+
+	def call_api(self, target_lang, code, stream_flag=False):
+		client = OpenAI(
+			base_url=self.api_url,
+			api_key=self.api_key,
+		)
+
+		completion = client.chat.completions.create(
+			extra_headers={},
+			model=self.api_model,
+			messages=[
+				{
+					"role": "system",
+					"content": "only display the code without any explanation",
+				},
+				{
+					"role": "user",
+					"content": f"translate this to {target_lang} language: {code}",
+				},
+			],
+			stream=stream_flag,
+		)
+
+		return completion

code_mage/codeMage.py

@@ -5,35 +5,70 @@
 from .translator import Translator
 from .loadConfig import load_config
 
+
 def main():
-    VERSION = "release 0.1"
+	VERSION = "release 0.1"
+
+	# Load config file
+	config = load_config()
+
+	parser = argparse.ArgumentParser(
+		description="This Tool translates a source file into another programming language."
+	)
+
+	# Arguments
+	parser.add_argument("source_files", nargs="*", help="The path to the source file to translate.")
 
-    # Load config file
-    config = load_config()
+	# Options
+	parser.add_argument(
+		"--language",
+		"-l",
+		help="The language to translate the source files into",
+		default=config.get("language"),
+	)
+	parser.add_argument(
+		"--output",
+		"-o",
+		help="Specify the output file name(without extension)",
+		default=config.get("output"),
+	)
+	parser.add_argument(
+		"--version",
+		"-v",
+		action="version",
+		version=f"CodeMage {VERSION}",
+		help="Show program's version number and exit",
+	)
+	parser.add_argument(
+		"--token-usage",
+		"-t",
+		action="store_true",
+		help="Get information about token usage for the prompt and response",
+		default=config.get("token_usage", False),
+	)
+	parser.add_argument(
+		"--model", "-m", help="Specify the LLM API model name", default=config.get("model")
+	)
+	parser.add_argument(
+		"--stream",
+		"-s",
+		action="store_true",
+		help="Stream out the output into stdout",
+		default=config.get("stream", False),
+	)
 
-    parser = argparse.ArgumentParser(description="This Tool translates a source file into another programming language.")
-    
-    # Arguments
-    parser.add_argument('source_files', nargs='*', help="The path to the source file to translate.")
+	args = parser.parse_args()
 
-    # Options
-    parser.add_argument('--language', '-l', help='The language to translate the source files into', default=config.get('language'))
-    parser.add_argument('--output', '-o', help="Specify the output file name(without extension)", default=config.get('output'))
-    parser.add_argument('--version', '-v', action='version', version=f'CodeMage {VERSION}', help="Show program's version number and exit")
-    parser.add_argument('--token-usage', '-t', action='store_true', help='Get information about token usage for the prompt and response', default=config.get('token_usage', False))
-    parser.add_argument('--model', '-m', help="Specify the LLM API model name", default=config.get('model'))
-    parser.add_argument('--stream', '-s', action='store_true', help='Stream out the output into stdout', default=config.get('stream', False))
-    
-    args = parser.parse_args()
+	if not args.source_files:
+		sys.exit(
+			"Welcome To CodeMage!\nIf you need a Help, Type the fllowing command:\npoetry run codemage -h"
+		)
 
-    if not args.source_files:
-        sys.exit("Welcome To CodeMage!\nIf you need a Help, Type the fllowing command:\npoetry run codemage -h")
+	translator = Translator(args, config)
 
-    translator = Translator(args, config)
-    
-    for index, file in enumerate(args.source_files):
-        translator.translate(file, index + 1)
+	for index, file in enumerate(args.source_files):
+		translator.translate(file, index + 1)
 
 
 if __name__ == "__main__":
-    main()
+	main()

code_mage/loadConfig.py

@@ -1,12 +1,13 @@
 import os
 import toml
 
+
 def load_config():
-    # Load config file from the project's root directory
-    config_path = os.path.expanduser("~/.codemage-config.toml")  # Adjust path to project root
-    if os.path.exists(config_path):
-        config = toml.load(config_path)
-    else:
-        config = {}
+	# Load config file from the project's root directory
+	config_path = os.path.expanduser("~/.codemage-config.toml")  # Adjust path to project root
+	if os.path.exists(config_path):
+		config = toml.load(config_path)
+	else:
+		config = {}
 
-    return config
+	return config