Minor edits (#5)

* fix : minor typo in feature_request.yml fixed

* doc : arguments help updated

* fix : test.yml updated

* doc : CHANGELOG.md updated

* fix : autopep8

* doc : code static analyzer badges added to README.md

* fix : codecov added to github-action

* doc : codecov badge added to README.md

* doc : minor edit in badges position

* doc : release date updated

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -27,7 +27,7 @@ body:
     validations:
       required: false
   - type: textarea
-    id: aditional-context
+    id: additional-context
     attributes:
       label: Additional context
       placeholder: >

.github/workflows/test.yml

@@ -31,6 +31,7 @@ jobs:
     - name: First test
       run: |
         mycoffee --version
+        mycoffee --method=chemex --water=20 --cups=3 --coffee-ratio=2 --water-ratio=37
     - name: Install dev-requirements
       run: |
         python otherfiles/requirements-splitter.py
@@ -48,3 +49,9 @@ jobs:
         python -m bandit -r mycoffee -s B311
         python -m pydocstyle --match-dir=mycoffee -v
       if: matrix.python-version == env.TEST_PYTHON_VERSION
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v4
+      with:
+          fail_ci_if_error: true
+          token: ${{ secrets.CODECOV_TOKEN }}
+      if: matrix.python-version == env.TEST_PYTHON_VERSION && matrix.os == env.TEST_OS

CHANGELOG.md

@@ -5,7 +5,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
-## [0.1] - 2024-xx-xx
+## [0.1] - 2024-09-01
 ### Added
 - 6 new methods
 	1. V60

README.md

@@ -1,8 +1,11 @@
 <div align="center">
 <h1>MyCoffee: Brew Perfect Coffee Right from Your Terminal</h1>
 <br/>
-<a href="https://badge.fury.io/py/mycoffee"><img src="https://badge.fury.io/py/mycoffee.svg" alt="PyPI version" height="18"></a>
 <a href="https://www.python.org/"><img src="https://img.shields.io/badge/built%20with-Python3-green.svg" alt="built with Python3"></a>
+<a href="https://badge.fury.io/py/mycoffee"><img src="https://badge.fury.io/py/mycoffee.svg" alt="PyPI version" height="18"></a>
+<a href="https://codecov.io/gh/sepandhaghighi/mycoffee" > 
+ <img src="https://codecov.io/gh/sepandhaghighi/mycoffee/graph/badge.svg?token=ZelznFDSPA"/> 
+ </a>
 </div>			
 				
 ## Overview	
@@ -41,9 +44,9 @@
 <table>
 	<tr> 
 		<td align="center">Code Quality</td>
-		<td align="center"></td>
-		<td align="center"></td>
-		<td align="center"></td>
+		<td align="center"><a href="https://www.codefactor.io/repository/github/sepandhaghighi/mycoffee"><img src="https://www.codefactor.io/repository/github/sepandhaghighi/mycoffee/badge" alt="CodeFactor"></a></td>
+		<td align="center"><a href="https://codebeat.co/projects/github-com-sepandhaghighi-mycoffee-main"><img alt="codebeat badge" src="https://codebeat.co/badges/8cb2671b-7640-4ac7-bb3e-823bb26a2db2" /></a></td>
+		<td align="center"><a href="https://app.codacy.com/gh/sepandhaghighi/mycoffee/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade"><img src="https://app.codacy.com/project/badge/Grade/ac0a8041879042d4a7925272ea3f7ba5"/></a></td>
 	</tr>
 </table>
 

mycoffee/__main__.py

@@ -13,10 +13,10 @@ def main():
     """
     parser = argparse.ArgumentParser()
     parser.add_argument('--method', help='brewing method', type=str, choices=sorted(METHODS_MAP), default="custom")
-    parser.add_argument('--info', help='brewing method info', type=str)
-    parser.add_argument('--coffee-ratio', help='coffee ratio', type=int)
-    parser.add_argument('--water-ratio', help='water ratio', type=int)
-    parser.add_argument('--water', help='water(ml)', type=float)
+    parser.add_argument('--info', help='information about the brewing method', type=str)
+    parser.add_argument('--coffee-ratio', help='coefficient for the coffee component in the ratio', type=int)
+    parser.add_argument('--water-ratio', help='coefficient for the water component in the ratio', type=int)
+    parser.add_argument('--water', help='amount of water in each cup (gr)', type=float)
     parser.add_argument('--cups', help='number of cups', type=int)
     parser.add_argument('--methods-list', help='brewing methods list', nargs="?", const=1)
     parser.add_argument('--version', help='version', nargs="?", const=1)

mycoffee/functions.py

@@ -17,8 +17,15 @@ def print_message(params):
     info = params["info"]
     if len(info) == 0:
         info = "Nothing :)"
-    print(MESSAGE_TEMPLATE.format(params["method"], params["cups"], params["coffee"], params["water"], params["coffee_ratio"], params["water_ratio"], info))
-
+    print(
+        MESSAGE_TEMPLATE.format(
+            params["method"],
+            params["cups"],
+            params["coffee"],
+            params["water"],
+            params["coffee_ratio"],
+            params["water_ratio"],
+            info))
 
 
 def load_method_params(method_name):
@@ -64,7 +71,7 @@ def load_params(args):
     params = load_method_params(args.method)
     for item in params:
         if getattr(args, item) is not None:
-                params[item] = getattr(args, item)
+            params[item] = getattr(args, item)
     params["method"] = args.method
     return params
 
@@ -99,4 +106,4 @@ def run(args):
         params = load_params(args)
         coffee = coffee_calc(params)
         params["coffee"] = coffee
-        print_message(params)
+        print_message(params)

mycoffee/params.py

@@ -44,8 +44,7 @@
         "water_ratio": 50,
         "water": 250,
         "info": "V60 method"
-    }
-    ,
+    },
     "espresso": {
         "coffee_ratio": 1,
         "water_ratio": 2,
@@ -63,8 +62,7 @@
         "water_ratio": 15,
         "water": 120,
         "info": "French press method"
-    }
-    ,
+    },
     "siphon": {
         "coffee_ratio": 1,
         "water_ratio": 15,