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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kattis-cli
-Version: 1.0.2
+Version: 1.0.3
 Summary: A command-line tool for Kattis
 Home-page: https://github.com/rambasnet/kattis-cli
 Author: Ram Basnet
@@ -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.3}/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.3}/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.3'
 
 from math import inf
 from typing import Tuple
@@ -15,10 +23,12 @@ 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]")

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

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "kattis-cli"
-version = "1.0.2"
+version = "1.0.3"
 authors = ["Ram Basnet <rambasnet@gmail.com>"]
 description = "A command-line tool for Kattis"
 readme = "README.md"