README.md file updated, test bug fixed

Author: gitdevjin

README.md

@@ -5,45 +5,77 @@
 **CodeMage** is a tool that translates a source file written in one programming language into another language.
 The translation will be done by Large Language Model AI(such as ChatGPT)
 
-## Release 1.0.0
 
-### Features
+
+## Features (Release 1.1.2)
 
     1. Supported Languages: Javascript, Python, C++, Java
     2. Default target Language is Python
     3. Supported LLM model: openrouter, groq
     4. Default LLM model is openrouter(sao10k/l3-euryale-70b)
 
-# Getting Started with `PyPI`
+
+
+<br>
+<br>
+
+# Getting started
+
+### Prerequisite
+
+
+1. Python
+- You need python 3.12 or later version to use this tool
+- Install Python : https://www.python.org/downloads/
+
+
+
+<br>
+<br>
+
+## Start with `PyPI`
 
 ### 1. Download the package using PyPI
 ```bash
+# for window user
 pip install code-mage
+
+# for mac user
+pip3 install code-mage
 ```
 
+<br>
+
 ### 2. Create your API_KEY at [openrouter](https://openrouter.ai/docs/api-keys) Or [Groq](https://console.groq.com/keys)
 
 It's free with sign-up. You can easily sign-up with your google account
 
+<br>
+
 ### 3.a Set-up the API_KEY using `Variable` (option 1)
 
 ```bash
-export API_KEY=YOUR-API-KEY
+export GROQ_API_KEY=YOUR-API-KEY # if you use groq model
+export OPENROUTER_API_KEY=YOUR-API-KEY # if you use openrouter model
 ```
 
+<br>
+
 ### 3.b Set-up with `.toml` file (option 2)
 
-With this option, you can also set other tool options.
+With this option, you can also set other tool options more easily
 
 - Start by creating a `.codemage-config.toml` in your home directory.
 
 ```bash
-mkdir ~/.codemage-config.toml
+vi ~/.codemage-config.toml
 ```
 
-- Add the following information to the file:
+- Add the following environment settings in the file:
 
 ```toml
+# the double quotes for string values are necessary.
+
 model="groq" # if you wish to use OPEN ROUTER you can just delete this line
 GROQ_API_KEY="<YOUR-GROQ-API-KEY>"
 OPENROUTER_API_KEY="<YOUR-OPEN-ROUTER-API-KEY>"
@@ -53,37 +85,42 @@ token_usage=false # if you wish to get token_usage info, set it `true`
 output="result" # type any name for the output file without the extension
 ```
 
+<br>
+
 ### 4. Run the tool
 
 ```bash
 codemage <file-you-want-to-convert>
+
 # For example,
 codemage test.js
+codemage test.js -s
+codemage test.js -m openrouter # specify your model, or the default model is "groq"
 ```
 
-# Getting Started by cloning the github repo
+<br>
 
-### 1. Install Python : https://www.python.org/downloads/
+# Start by cloning the github repo
 
-<br>
+If you are using the tool by cloning the repo, you need poetry package manager.
 
-### 2. Install Poetry
+### 1. Install Poetry (if not installed yet)
 
 ```console
 curl -sSL https://install.python-poetry.org | python3 -
 ```
 
 **OR** if you have `pipx` installed on your local machine, you can use the following commend
 
-[How to download `pipx`](https://github.com/pypa/pipx)
-
 ```console
 pipx install poetry
 ```
 
+Refer to [How to download pipx](https://github.com/pypa/pipx)
+
 <br>
 
-### 3. Clone the repository
+### 2. Clone the repository
 
 ```console
 git clone https://github.com/gitdevjin/code-mage.git
@@ -92,35 +129,44 @@ cd code_mage
 
 <br>
 
-### 4. Install Poetry Package
+### 3. Install Poetry Dependencies
 
 ```console
 poetry install
 ```
 
 <br>
 
-### 5. Create your API_KEY at [openrouter](https://openrouter.ai/docs/api-keys) Or [Groq](https://console.groq.com/keys)
+### 4. Create your API_KEY at [openrouter](https://openrouter.ai/docs/api-keys) Or [Groq](https://console.groq.com/keys)
 
 It's free with sign-up. You can easily sign-up with your google account
 
 <br>
 
-### 6. Create `.env` file in the root directory and save the following:
+### 5-a Create `.env` file in the root directory and save the following:
 
 ```
 OPENROUTER_API_KEY=your_open_router_api_key
 GROQ_API_KEY=your_groq_api_key
 ```
+<br>
+
+### 5-b Using TOML files
+
+You can also use `.toml` file with this method
+Refer to [this](#3b-set-up-with-toml-file-option-2)
 
 Now you are ready to use the tool!
 
 <br>
 
 # Usage
 
+- Run the command
+
 ```console
 poetry run codemage <source_file>
+poetry run codemage ./example/test.js
 ```
 
 ## Examples
@@ -155,34 +201,6 @@ You can stream out the result onto `stdout` with `-s, --stream` flag:
 poetry run codemage ./example/test.js -s
 ```
 
-### Using TOML files
-
-If you wish, you can specify all of your options in a TOML formatted configuration.
-
-- Start by creating a `.codemage-config.toml` in your home directory.
-
-```bash
-mkdir ~/.codemage-config.toml
-```
-
-- Add the following information to the file:
-
-```toml
-model="groq" # if you wish to use OPEN ROUTER you can just delete this line
-GROQ_API_KEY="<YOUR-GROQ-API-KEY>"
-OPENROUTER_API_KEY="<YOUR-OPEN-ROUTER-API-KEY>"
-language="java" # you can use any of the supported languages
-stream=false/true
-token_usage=false/true
-output="result" # type any name for the output file without the extension
-```
-
-- Run the command
-
-```
-poetry run codemage ./example/test.js
-```
-
 ## Options
 
 -h, --help : display help message and exit

code_mage/argsParser.py

@@ -2,7 +2,7 @@
 
 
 def arg_parser(config):
-	VERSION = config.get("version")
+	VERSION = "1.1.2"
 
 	parser = argparse.ArgumentParser(
 		description="This Tool translates a source file into another programming language."

code_mage/loadConfig.py

@@ -10,12 +10,4 @@ def load_config():
 	else:
 		config = {}
 
-	config["version"] = __get_version_from_pyproject()
-
 	return config
-
-
-def __get_version_from_pyproject():
-	with open("pyproject.toml", "r") as f:
-		pyproject_data = toml.load(f)
-	return pyproject_data["tool"]["poetry"]["version"]

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "code-mage"
-version = "1.0.0"
+version = "1.1.2"
 description = ""
 authors = ["gitdevjin <[email protected]>"]
 readme = "README.md"

tests/test_loadConfig.py

@@ -1,74 +1,37 @@
 import os
-from unittest.mock import patch, mock_open
+from unittest.mock import patch
 from code_mage.loadConfig import load_config  # Adjust the import path accordingly
 
 
 class TestLoadConfig:
 	@patch("os.path.exists")
 	@patch("toml.load")
-	@patch("builtins.open", new_callable=mock_open)
-	def test_load_config_file_exists(self, mock_file, mock_toml_load, mock_os_exists):
-		# Simulate that the config file exists
+	def test_load_config_file_exists(self, mock_toml_load, mock_os_exists):
+		# Simulate that the file exists
 		mock_os_exists.return_value = True
 
-		# Simulate the contents of the config file
-		mock_toml_load.side_effect = [
-			{
-				"language": "Python",
-				"OPENROUTER_API_KEY": "mock_openrouter_api_key",
-			},  # First call (config file)
-			{"tool": {"poetry": {"version": "0.9.0"}}},  # Second call (pyproject.toml)
-		]
-
-		# Call load_config function
-		config = load_config()
-
-		# Assertions
-		mock_os_exists.assert_called_once_with(os.path.expanduser("~/.codemage-config.toml"))
-		mock_file.assert_called_once_with("pyproject.toml", "r")
-		assert config == {
+		# Simulate the contents of the file
+		mock_toml_load.return_value = {
 			"language": "Python",
 			"OPENROUTER_API_KEY": "mock_openrouter_api_key",
-			"version": "0.9.0",
 		}
 
-	@patch("os.path.exists")
-	@patch("toml.load")
-	@patch("builtins.open", new_callable=mock_open)
-	def test_load_config_file_with_no_content(self, mock_file, mock_toml_load, mock_os_exists):
-		# Simulate that the file does not exist
-		mock_os_exists.return_value = True
-
-		# Call the function under test
-
-		mock_toml_load.side_effect = [
-			{},
-			{"tool": {"poetry": {"version": "0.9.0"}}},  # Second call (pyproject.toml)
-		]
-
+		# Call load_config function
 		config = load_config()
 
 		# Assertions
 		mock_os_exists.assert_called_once_with(os.path.expanduser("~/.codemage-config.toml"))
-		mock_file.assert_called_once_with("pyproject.toml", "r")
+		mock_toml_load.assert_called_once_with(os.path.expanduser("~/.codemage-config.toml"))
+		assert config == {"language": "Python", "OPENROUTER_API_KEY": "mock_openrouter_api_key"}
 
-		# Assert the default config with version added
-		assert config == {"version": "0.9.0"}
-
-	@patch("os.path.exists")  # Third argument
-	@patch("builtins.open")  # Second argument
-	@patch("toml.load")  # First argument
-	def test_load_config_file_not_exists(self, mock_toml_load, mock_file, mock_os_exists):
-		# Simulate that the config file does not exist
+	@patch("os.path.exists")
+	def test_load_config_file_not_exists(self, mock_os_exists):
+		# Simulate that the file does not exist
 		mock_os_exists.return_value = False
 
-		# Simulate the content of the pyproject.toml file
-		mock_toml_load.return_value = {"tool": {"poetry": {"version": "0.9.0"}}}
-
 		# Call the function under test
 		config = load_config()
 
 		# Assertions
 		mock_os_exists.assert_called_once_with(os.path.expanduser("~/.codemage-config.toml"))
-		mock_file.assert_called_once_with("pyproject.toml", "r")
-		assert config == {"version": "0.9.0"}
+		assert config == {}