minor updates

- wrote more tests
- fix how exceptions are raised
- wrote docs for api()

Author: Bhupesh-V

.readthedocs.yml

@@ -6,8 +6,6 @@
 version: 2
 
 # Build documentation with MkDocs
-#mkdocs:
-#  configuration: mkdocs.yml
 mkdocs:
   configuration: mkdocs.yml
   fail_on_warning: false

.travis.yml

@@ -6,7 +6,6 @@ python:
 
 install:
   - pip install -r requirements.txt
-  - pip install isort black flake8 pylint
   - pip install codecov
 script:
   - python tests.py

CHANGELOG.md

@@ -3,7 +3,7 @@
 All notable changes to this project will be documented in this file.
 
 ## [1.0] - June , 2020
-⚠ Major Update (Breaking Changes)
+⚠ **Major Update (Breaking Changes)**
 
 ### Added
 - Add API key authorizations

coderunner/coderunner.py

@@ -64,9 +64,6 @@ class ValueTooLargeError(Exception):
 class InvalidURL(Exception):
     """Raise when api_url is invalid"""
 
-    def __init__(self, message):
-        super().__init__(message)
-
 
 class code:
     """
@@ -221,21 +218,15 @@ def getTime(self):
 
     def setFlags(self, options: str):
         """Options for the compiler (i.e. compiler flags)"""
-        try:
-            if len(options) > 128:
-                raise ValueTooLargeError
-            api_params["compiler_options"] = options
-        except ValueTooLargeError:
-            print("Maximum 128 characters allowed")
+        if len(options) > 128:
+            raise ValueTooLargeError("Maximum 128 characters allowed")
+        api_params["compiler_options"] = options
 
     def setArguments(self, arguments: str):
         """Command line arguments for the program"""
-        try:
-            if len(arguments) > 128:
-                raise ValueTooLargeError
-            api_params["command_line_arguments"] = arguments
-        except ValueTooLargeError:
-            print("Maximum 128 characters allowed")
+        if len(arguments) > 128:
+            raise ValueTooLargeError("Maximum 128 characters allowed")
+        api_params["command_line_arguments"] = arguments
 
     def run(self, number_of_runs: int = 1):
         """Submit the source code on judge0's server & return status"""

docs/changelog.md

@@ -1,5 +1,16 @@
 # Changelog
 
+All notable changes to this project will be documented in this file.
+
+## [1.0] - June , 2020
+⚠ **Major Update (Breaking Changes)**
+
+### Added
+- Add API key authorizations
+- Custom API URL support
+
+### Changed
+- Due to Judge0 API going [freemium](https://github.com/judge0/api/issues/171), the default API URL, [https://api.judge0.com] is no longer available. To use the API signup for a plan on [RapidAPI](https://rapidapi.com/hermanzdosilovic/api/judge0/pricing)
 
 
 ## [0.8] - May 27, 2020
@@ -8,14 +19,20 @@
 - Fixed bug where compiling a Java program resulted in Compilation Error.
 
 
+## [0.7] - Jan 19, 2020
+
+### Changed
+- `code()` class now ignores `output`. i.e you can just provide source code & language to run a program.
+
+
 ## [0.6] - Jan 5, 2020
 
 ### Added
 
 - New optional argument, `number_of_runs`  in `run()` method, use this to specify no.of times you want to run the code. Default is set to 1.
 - Ported NEW Languages. CodeRunner now supports all languages provided by Judge0.
-- [`setFlags(options)`](/usage/#9-setflagsoptions) for setting options for the compiler (i.e. compiler flags).
-- [`setArguments(arguments)`](/usage/#10-setargumentsarguments) for setting Command line arguments for the program.
+- `setFlags(options)` for setting options for the compiler (i.e. compiler flags).
+- `setArguments(arguments)` for setting Command line arguments for the program.
 
 ### Changed
 - Minor internal improvemets.
@@ -67,7 +84,4 @@ This is effect fixes [#2](https://github.com/codeclassroom/CodeRunner/issues/2).
 
 
 ## [0.1] - Oct 30, 2019
-- Initial Release
-
-# Releases
-See releases on [PyPi](https://pypi.org/project/coderunner/#history)
+- Initial Release

docs/usage.md

@@ -1,6 +1,6 @@
 # Usage
 
-coderunner provides the following class constructors
+coderunner provides the following class.
 
 ### code(source, lang, output, inp, path)
 
@@ -52,6 +52,41 @@ print(r.languages)
 
 Methods available in class `code()`.
 
+### api()
+
+Since v1.0, you need to provide a API Key & URL for using Judge0 through coderunner.
+
+Here is an example on how to do this.
+
+```python
+from coderunner import coderunner
+import os
+from dotenv import load_dotenv
+
+load_dotenv()
+
+source_code = "testfiles/" + "test_python_input.py"
+language = "Python3"
+output = "testfiles/output/" + "output2.txt"
+Input = "testfiles/input/" + "input.txt"
+
+
+API_KEY = os.environ["API_KEY"]
+
+r = coderunner.code(source_code, language, output, Input)
+
+# Necessary step to initialize API keys & URL
+r.api(key=API_KEY)
+
+r.run()
+
+print("Run r :")
+print("Status : " + r.getStatus())
+print("Output : " + r.getOutput())
+````
+
+The default API URL is [https://judge0.p.rapidapi.com/]()
+
 ### 1. run()
 **Parameters(type)** : Number Of Runs (`int`), optional<br>
 **Return Type** : None <br>

mkdocs.yml

@@ -2,8 +2,8 @@ site_name: CodeRunner
 site_url: https://codeclassroom.github.io/CodeRunner/
 repo_url: https://github.com/codeclassroom/CodeRunner
 site_author: Bhupesh Varshney
-site_description: CodeRunner v0.5 Documentation
-copyright: © 2019, Bhupesh Varshney
+site_description: CodeRunner v1.0 Documentation
+copyright: © 2020, Bhupesh Varshney
 nav:
     - Documentation: index.md
     - Installation: installation.md

tests.py

@@ -1,6 +1,6 @@
 import unittest
 from coderunner import coderunner
-from coderunner.coderunner import InvalidURL
+from coderunner.coderunner import InvalidURL, ValueTooLargeError
 # # test for Java program
 
 
@@ -174,5 +174,27 @@ def test_run(self):
             r.api(key="ABCHE", url="ghthth")
 
 
+# test to check ValueTooLargeError for Flags
+class TestRunP(unittest.TestCase):
+    def test_run(self):
+        source_code = 'print("This will return Wrong Answer")'
+        language = "Python3"
+        output = "Wrong Answer"
+        r = coderunner.code(source_code, language, output, path=False)
+        with self.assertRaises(ValueTooLargeError):
+            r.setFlags("qw"*70)
+
+
+# test to check ValueTooLargeError for Arguments
+class TestRunQ(unittest.TestCase):
+    def test_run(self):
+        source_code = 'print("This will return Wrong Answer")'
+        language = "Python3"
+        output = "Wrong Answer"
+        r = coderunner.code(source_code, language, output, path=False)
+        with self.assertRaises(ValueTooLargeError):
+            r.setArguments("qw"*70)
+
+
 if __name__ == "__main__":
     unittest.main()