kattis-cli 1.0.2__tar.gz → 1.0.4__tar.gz

{kattis_cli-1.0.2 → kattis_cli-1.0.4}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: kattis-cli
-Version: 1.0.2
+Version: 1.0.4
 Summary: A command-line tool for Kattis
 Home-page: https://github.com/rambasnet/kattis-cli
 Author: Ram Basnet
-Author-email: rambasnet@gmail.com
+Author-email: rbasnet@coloradomesa.edu
 Requires-Python: >=3.8,<4.0
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
@@ -75,21 +75,25 @@ If you've Python version 3.8 or higher, you can skip creating virtual environmen
 ```bash
 pip install kattis-cli
 python -m pip install kattis-cli
+kattis --version
 ```
 
 - on Windows add the path shown in the output of the above command to your PATH environment variable
 
-
-## Update Kattis-CLI
+## Update/Upgrade Kattis-CLI
 
 - remove or rename **.kattis-cli.toml** file in your home directory
 - activate virtual environment if you've created one for kattis-cli
 
 ```bash
+kattis --version
 pip install kattis-cli --upgrade
 python -m pip install kattis-cli --upgrade
 ```
 
+- on Windows add the path shown in the output of the above command to your PATH environment variable
+
+
 ## Kattis configuration
 
 - run the following command and enter your Kattis credentials
@@ -113,13 +117,13 @@ kattis --help
 - problem id can be found in the last part of the URL of the problem
 - example: [https://open.kattis.com/problems/cold](https://open.kattis.com/problems/cold) => problem id: **cold**
 
-![Problem id](images/problemid.png)
+![Problem id](./images/problemid.png)
 
 ```bash
 kattis get <problem_id>
 ```
 
-![Get problem id from URL](images/kattis_get.png)
+![Get problem id from URL](./images/kattis_get.png)
 
 ### Display problem metadata
 
@@ -128,10 +132,12 @@ cd <problem_id>
 kattis info
 ```
 
-![Problem info](images/kattis_info.png)
+![Problem info](./images/kattis_info.png)
 
 ### Test a solution locally
 
+![Test](images/kattis_test.png)
+
 - currently the following languages have been tested: Python 3, C++, NodeJS, C, Java
 - make sure CLI compilers are in your PATH
 - make sure python3 files have first line shebang: !/usr/bin/env python3
@@ -141,10 +147,20 @@ kattis info
 
 ```bash
 cd <problem_id>
-kattis test
+kattis test # for exact comparion of answers (string and int)
+kattis test -a 6 # Answer accepted upto 6 decimal places of accuracy
+```
+
+### Testing floating point results
+
+- for floating point ouput, problem provides the tolerance or accuracy upto certain decimal points
+- one can use `-a <N>` switch after kattis test command to provide the decimal places of accuracy
+- e.g., the following command checks for accuracy upto 6 decimal points or absolute error upto $10^-6$
+
+```bash
+kattis test -a 6
 ```
 
-![Test](images/kattis_test.png)
 
 ### Submit a problem
 

{kattis_cli-1.0.2 → kattis_cli-1.0.4}/README.md

@@ -49,21 +49,25 @@ If you've Python version 3.8 or higher, you can skip creating virtual environmen
 ```bash
 pip install kattis-cli
 python -m pip install kattis-cli
+kattis --version
 ```
 
 - on Windows add the path shown in the output of the above command to your PATH environment variable
 
-
-## Update Kattis-CLI
+## Update/Upgrade Kattis-CLI
 
 - remove or rename **.kattis-cli.toml** file in your home directory
 - activate virtual environment if you've created one for kattis-cli
 
 ```bash
+kattis --version
 pip install kattis-cli --upgrade
 python -m pip install kattis-cli --upgrade
 ```
 
+- on Windows add the path shown in the output of the above command to your PATH environment variable
+
+
 ## Kattis configuration
 
 - run the following command and enter your Kattis credentials
@@ -87,13 +91,13 @@ kattis --help
 - problem id can be found in the last part of the URL of the problem
 - example: [https://open.kattis.com/problems/cold](https://open.kattis.com/problems/cold) => problem id: **cold**
 
-![Problem id](images/problemid.png)
+![Problem id](./images/problemid.png)
 
 ```bash
 kattis get <problem_id>
 ```
 
-![Get problem id from URL](images/kattis_get.png)
+![Get problem id from URL](./images/kattis_get.png)
 
 ### Display problem metadata
 
@@ -102,10 +106,12 @@ cd <problem_id>
 kattis info
 ```
 
-![Problem info](images/kattis_info.png)
+![Problem info](./images/kattis_info.png)
 
 ### Test a solution locally
 
+![Test](images/kattis_test.png)
+
 - currently the following languages have been tested: Python 3, C++, NodeJS, C, Java
 - make sure CLI compilers are in your PATH
 - make sure python3 files have first line shebang: !/usr/bin/env python3
@@ -115,10 +121,20 @@ kattis info
 
 ```bash
 cd <problem_id>
-kattis test
+kattis test # for exact comparion of answers (string and int)
+kattis test -a 6 # Answer accepted upto 6 decimal places of accuracy
+```
+
+### Testing floating point results
+
+- for floating point ouput, problem provides the tolerance or accuracy upto certain decimal points
+- one can use `-a <N>` switch after kattis test command to provide the decimal places of accuracy
+- e.g., the following command checks for accuracy upto 6 decimal points or absolute error upto $10^-6$
+
+```bash
+kattis test -a 6
 ```
 
-![Test](images/kattis_test.png)
 
 ### Submit a problem
 

{kattis_cli-1.0.2 → kattis_cli-1.0.4}/kattis_cli/download.py

@@ -2,14 +2,12 @@
     and save them to data folders.
 """
 
-# import sys
 import shutil
 from typing import Any, Dict
 from pathlib import Path
 import requests
 import yaml
 from bs4 import BeautifulSoup
-
 from .utils import config, utility
 from . import settings
 

{kattis_cli-1.0.2 → kattis_cli-1.0.4}/kattis_cli/kattis.py

@@ -20,7 +20,7 @@ from rich.align import Align
 from rich.live import Live
 from rich.prompt import Confirm
 
-from kattis_cli.utils import utility
+from kattis_cli.utils import languages
 from kattis_cli.utils import config
 from kattis_cli import ui
 
@@ -182,7 +182,7 @@ def confirm_or_die(problem: str, language: str,
     console.print('Language:', language)
     console.print('Files:', ', '.join(files))
     if mainclass:
-        if language in utility.GUESS_MAINFILE:
+        if language in languages.GUESS_MAINFILE:
             console.print('Main file:', mainclass)
         else:
             console.print('Mainclass:', mainclass)

{kattis_cli-1.0.2 → kattis_cli-1.0.4}/kattis_cli/main.py

@@ -1,5 +1,13 @@
-""" Main module for the kattis_cli package."""
-__version__ = '1.0.2'
+""" Main module for the kattis_cli package.
+This is the main.py file for the kattis_cli package.
+
+Change the contents here instead of main.py.
+build.sh script copies the contents of this file to main.py.
+
+Change the __version__ to match in pyproject.toml
+Has to be higher than the pypi version.
+"""
+__version__ = '1.0.4'
 
 from math import inf
 from typing import Tuple
@@ -10,15 +18,17 @@ import kattis_cli.download as download
 import kattis_cli.ui as ui
 import kattis_cli.test_solution as test_solution
 import kattis_cli.kattis as kattis
-import kattis_cli.utils.utility as utility
+import kattis_cli.utils.languages as languages
 import kattis_cli.kattis_setup as kattis_setup
 
 
 @click.group()
+@click.version_option(version=__version__, prog_name='kattis-cli')
 def main() -> None:
     """
     CLI for downloading, testing and submitting Kattis problems.
     """
+    pass
 
 
 @main.command(help='Download sample data & metadata.')
@@ -34,7 +44,7 @@ def get(problemid: str) -> None:
     except requests.exceptions.InvalidURL:
         console.print(
             f"""Sample data for Problem ID: [bold blue]
-{problemid}[/bold blue] not found.")
+            {problemid}[/bold blue] not found.")
             """)
     console.print(
         f"Downloading metadata: [bold blue]{problemid}[/bold blue]")
@@ -65,11 +75,11 @@ def test(
     """Test solution with sample files.
     """
     problemid, loc_language, mainclass, _files, root_folder, lang_config = \
-        utility.update_args(problemid, language, mainclass, list(files))
+        languages.update_args(problemid, language, mainclass, list(files))
     # print('After - ', f'{problemid=} {language=} {mainclass=} {_files=}')
     # lang_config = config.parse_config(language)
     if not mainclass:
-        mainclass = utility.guess_mainfile(
+        mainclass = languages.guess_mainfile(
             language, _files, problemid, lang_config)
 
     test_solution.test_samples(
@@ -101,14 +111,14 @@ def submit(problemid: str, language: str,
     """Submit a solution to Kattis.
     """
     problemid, language, mainclass, _files, _, lang_config = \
-        utility.update_args(
+        languages.update_args(
             problemid, language, mainclass, list(files))
     # Finally, submit the solution
     # print(f'{problemid=} {language=} {mainclass=} {tag=} {force=} {_files=}')
     if not mainclass:
-        mainclass = utility.guess_mainfile(
+        mainclass = languages.guess_mainfile(
             language, _files, problemid, lang_config)
-    kat_lang = utility.LOCAL_TO_KATTIS[language]
+    kat_lang = languages.LOCAL_TO_KATTIS[language]
     kattis.submit_solution(_files, problemid,
                            kat_lang, mainclass,
                            tag, force)

{kattis_cli-1.0.2 → kattis_cli-1.0.4}/kattis_cli/test_solution.py

@@ -1,7 +1,6 @@
 """Tester module for Kattis.
 """
 
-from math import inf
 from typing import Any, List, Dict
 import glob
 import time
@@ -17,26 +16,7 @@ from rich.prompt import Confirm
 from rich.markup import escape
 
 from kattis_cli import kattis
-from kattis_cli.utils import run_program, utility
-
-
-def compare_floats(expected: str, ans: str, places: float) -> bool:
-    """Compare two floating point numbers with given accuracy.
-
-    Args:
-        expected (str): expected result
-        ans (str): actual result
-        places (float): decimal places for approximation
-
-    Returns:
-        bool: True if the two numbers are equal within the given accuracy
-    """
-    try:
-        flt_expected = float(expected)
-        flt_ans = float(ans)
-        return abs(flt_expected - flt_ans) <= 10**(-places)
-    except ValueError:
-        return False
+from kattis_cli.utils import languages, run_program, utility
 
 
 def test_samples(
@@ -46,7 +26,7 @@ def test_samples(
         problem_root_folder: str,
         files: List[str],
         lang_config: Dict[Any, Any],
-        accuracy: float = inf
+        accuracy: float = 0
 ) -> None:
     """Tests a problem by running all the .in files in
     the problem folder and comparing the output to the .ans files.
@@ -147,14 +127,15 @@ def test_samples(
             if code != 0:
                 ans = error
             # console.print(f"{ans=} {error=}")
-            if accuracy == inf:  # string comparison
+            if accuracy == 0:  # string comparison
                 if expected == ans.encode('utf-8').strip():
                     result = "[bold green]✅[/bold green]"
                     count += 1
                 else:
                     result = "[bold red]❌[/bold red]"
             else:  # floating point comparison
-                if compare_floats(expected.decode('utf-8'), ans, accuracy):
+                if utility.compare_floats(expected.decode('utf-8'),
+                                          ans, accuracy):
                     result = "[bold green]✅[/bold green]"
                     count += 1
                 else:
@@ -188,7 +169,7 @@ def test_samples(
             "Awesome... Time to submit it to :cat: Kattis! :cat:",
             style="bold green")
         if Confirm.ask("Submit to Kattis?", default=True):
-            kat_language = utility.LOCAL_TO_KATTIS.get(loc_language, '')
+            kat_language = languages.LOCAL_TO_KATTIS.get(loc_language, '')
             kattis.submit_solution(files, problemid,
                                    kat_language, mainclass,
                                    tag="", force=True)

{kattis_cli-1.0.2 → kattis_cli-1.0.4}/kattis_cli/utils/config.py

@@ -9,7 +9,7 @@ import configparser
 from tomlkit import load
 import yaml
 
-from .utility import find_problem_root_folder
+from kattis_cli.utils.utility import find_problem_root_folder
 
 _DEFAULT_CONFIG = Path.home().joinpath('.kattisrc')
 

kattis_cli-1.0.2/kattis_cli/utils/utility.py → kattis_cli-1.0.4/kattis_cli/utils/languages.py

@@ -1,14 +1,14 @@
 """Module for language utilities.
 """
 
-from typing import List, Union, Any, Dict
+from typing import List, Dict, Any
 import sys
 import os
 import re
 from pathlib import Path
-import yaml
 from rich.console import Console
 from kattis_cli.utils import config
+from kattis_cli.utils.utility import find_problem_root_folder
 
 
 LANGUAGE_GUESS = {
@@ -248,60 +248,6 @@ def valid_extension(file: str) -> bool:
     return False
 
 
-def find_problem_root_folder(
-    cur_dir_path: Union[str, Path],
-    filename: str
-) -> Path:
-    """Find the root problem folder given a directory path and filename.
-
-    Args:
-        cur_dir_path (Union[str, Path]): String or Path
-            object of directory path
-        filename (str): filename to search for
-            including wildcard pattern
-
-    Returns:
-        Path: Path object of the root problem folder
-    """
-
-    def _check_file_match_folder(path: Path, filename: str) -> bool:
-        """ Check folder is same name as the filename given
-        filename including wildcard.
-
-        Args:
-            path (Path): Path object of directory path
-            filename (str): filename to search for
-                including wildcard pattern
-        Returns:
-            bool: True if path exists, False otherwise
-        """
-        for file in path.glob(filename):
-            name, ext = os.path.splitext(file.name)
-            folder_name = path.parts[-1]
-            # print(f'{name} {folder_name=} {name=} {ext=}')
-            if name == folder_name:
-                return True
-            # read yaml file
-            if ext == '.yaml':
-                with open(file, 'r', encoding='utf-8') as f:
-                    data = yaml.safe_load(f)
-                    if 'problemid' in data:
-                        return True
-        return False
-
-    # print(f'{cur_dir_path=} {filename=}')
-    if not filename:
-        filename = '.yaml'
-    cur_path = Path(cur_dir_path)
-    if _check_file_match_folder(cur_path, filename):
-        return cur_path
-    for parent in cur_path.parents:
-        # print('parent', parent, file=sys.stderr)
-        if _check_file_match_folder(parent, filename):
-            return parent
-    raise FileNotFoundError("Error: Problem root folder not found.")
-
-
 # flake8: noqa: C901
 def update_args(problemid: str,
                 loc_language: str,

kattis_cli-1.0.4/kattis_cli/utils/utility.py

@@ -0,0 +1,86 @@
+""" Utility functions. """
+
+from pathlib import Path
+import os
+from typing import Union
+import yaml
+
+
+def find_problem_root_folder(
+    cur_dir_path: Union[str, Path],
+    filename: str
+) -> Path:
+    """Find the root problem folder given a directory path and filename.
+
+    Args:
+        cur_dir_path (Union[str, Path]): String or Path
+            object of directory path
+        filename (str): filename to search for
+            including wildcard pattern
+
+    Returns:
+        Path: Path object of the root problem folder
+    """
+
+    def _check_file_match_folder(path: Path, filename: str) -> bool:
+        """ Check folder is same name as the filename given
+        filename including wildcard.
+
+        Args:
+            path (Path): Path object of directory path
+            filename (str): filename to search for
+                including wildcard pattern
+        Returns:
+            bool: True if path exists, False otherwise
+        """
+        for file in path.glob(filename):
+            name, ext = os.path.splitext(file.name)
+            folder_name = path.parts[-1]
+            # print(f'{name} {folder_name=} {name=} {ext=}')
+            if name == folder_name:
+                return True
+            # read yaml file
+            if ext == '.yaml':
+                with open(file, 'r', encoding='utf-8') as f:
+                    data = yaml.safe_load(f)
+                    if 'problemid' in data:
+                        return True
+        return False
+
+    # print(f'{cur_dir_path=} {filename=}')
+    if not filename:
+        filename = '.yaml'
+    cur_path = Path(cur_dir_path)
+    if _check_file_match_folder(cur_path, filename):
+        return cur_path
+    for parent in cur_path.parents:
+        # print('parent', parent, file=sys.stderr)
+        if _check_file_match_folder(parent, filename):
+            return parent
+    raise FileNotFoundError("Error: Problem root folder not found.")
+
+
+def compare_floats(expected: str, ans: str, places: float) -> bool:
+    """Compare two floating point numbers with given accuracy.
+
+    Args:
+        expected (str): expected result
+        ans (str): actual result
+        places (float): decimal places for approximation
+
+    Returns:
+        bool: True if the two numbers are equal within the given accuracy
+    """
+    expect_ans = expected.strip().split('\n')
+    actual_ans = ans.strip().split('\n')
+    if len(expect_ans) != len(actual_ans):
+        return False
+    try:
+        for i, ex_ans in enumerate(expect_ans):
+            flt_expected = float(ex_ans)
+            flt_ans = float(actual_ans[i])
+            if abs(flt_expected - flt_ans) > 10**(-places):
+                return False
+        return True
+    except ValueError:
+        return False

{kattis_cli-1.0.2 → kattis_cli-1.0.4}/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "kattis-cli"
-version = "1.0.2"
-authors = ["Ram Basnet <rambasnet@gmail.com>"]
+version = "1.0.4"
+authors = ["Ram Basnet <rbasnet@coloradomesa.edu>"]
 description = "A command-line tool for Kattis"
 readme = "README.md"
 repository = "https://github.com/rambasnet/kattis-cli"