Merge pull request #3 from codeclassroom/dev

0.5 release

Author: Bhupesh-V

.travis.yml

@@ -14,6 +14,6 @@ script:
   - isort --check-only --recursive coderunner
   - black --check --diff coderunner
   - flake8 coderunner --max-line-length=88 --ignore=F401
-  - pylint coderunner --disable=bad-continuation,invalid-name,too-many-instance-attributes,too-many-arguments
+  - pylint coderunner --disable=bad-continuation,invalid-name,too-many-instance-attributes,too-many-arguments,attribute-defined-outside-init
 after_success:
   - codecov

CHANGELOG.md

@@ -0,0 +1,52 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+
+## [0.5] - Dec 20, 2019
+
+### Added
+
+- New instance method - `run()`.
+- `run()` is now used to run the code i.e the code is submitted to Judge0 api using this method.
+- Support for *Bash 4.4*.
+
+### Changed
+- Renamed Class `Run` to `code` for easier usage.
+- `getStatus()`, now only returns the status in comparison to earlier versions where it performed multiple tasks.
+This is effect fixes [#2](https://github.com/codeclassroom/CodeRunner/issues/2).
+
+### Removed
+ - `requests` as a dependency, Network requests are now 50% faster.
+
+
+## [0.4] - Nov 11, 2019
+
+### Added
+
+- `getSubmissionDate()`, `getExitCode` new methods.
+- Official Documentation.
+
+### Changed
+
+- Class Run `init` - Now you can pass _source code_, _input_ and _output_ to program as strings (limited to file paths in prior versions).
+
+
+## [0.3] - Nov 9, 2019
+
+### Added
+
+- Removed redundant imports
+- Added Module/Class docstrings for documentation
+- Formatted Code
+
+
+## [0.2] - Oct 31, 2019
+
+### Changed
+
+- Fix import requests problem.
+
+
+## [0.1] - Oct 30, 2019
+- Initial Release

README.md

@@ -1,6 +1,6 @@
 # CodeRunner 🏃
 
-> [Judge0 API](https://api.judge0.com/) Interface written in Python
+> A judge 👨🏽‍⚖️ for your programs, run and test your programs through Python
 
 
 ![PyPI](https://img.shields.io/pypi/v/coderunner?color=blue)
@@ -25,25 +25,26 @@ or directly from GitHub if you cannot wait to test new features
 ```bash
 pip install git+https://github.com/codeclassroom/CodeRunner.git
 ```
+
 ## Usage
 
 ```python
 
 import coderunner
 
-program_name = "path-to/test_python.py"
+source_code = "path-to/test_python.py"
 language = "Python"
-output = "path-to/output.txt"
-Input = "path-to/input.txt"
+expected_output = "path-to/output.txt"
+standard_input = "path-to/input.txt"
 
 # use this if you have a standard input to Program
-r = coderunner.Run(program_name, language, output, Input)
+r = coderunner.code(source_code, language, expected_output, standard_input)
 
 # otherwise
-r = coderunner.Run(program_name, language, output)
+r = coderunner.code(source_code, language, expected_output)
 
-# if not using file paths
-r = coderunner.Run("Hello, World", language, "Hello, World", path=False)
+# Use path=False if not using file paths
+r = coderunner.code("Hello, World", language, "Hello, World", path=False)
 ```
 
 ## Documentation
@@ -79,9 +80,9 @@ flake8 coderunner --max-line-length=88 --ignore=F401
 pylint coderunner --disable=bad-continuation,invalid-name,too-many-instance-attributes
 ```
 
-## Changelog
+## 📝 Changelog
 
-Changelog can be found in [Releases](https://github.com/codeclassroom/CodeRunner/releases)
+See the [CHANGELOG.md](CHANGELOG.md) file for details.
 
 
 ## Author
@@ -93,7 +94,7 @@ Changelog can be found in [Releases](https://github.com/codeclassroom/CodeRunner
 
 [![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://forthebadge.com)
 
-## 📝 License
+## 📜 License
 
 This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
 

coderunner/__init__.py

@@ -1,2 +1,2 @@
 """Import Run() for initializing program data"""
-from coderunner.coderunner import Run
+from coderunner.coderunner import code

coderunner/coderunner.py

@@ -3,12 +3,13 @@
 ====================================
 The core module of CodeRunner
 """
+import json
 import os
-
-import requests
+import urllib.parse
+import urllib.request
 
 # language IDs on judge0, see Documentation
-languages = {"C++": 10, "Java": 27, "Python": 34, "C": 4}
+languages = {"C++": 10, "Java": 27, "Python": 34, "C": 4, "Bash": 1}
 
 api_params = {
     "number_of_runs": "1",
@@ -27,7 +28,7 @@
 FIELDS = "?fields=stdout,memory,time,status,stderr,exit_code,created_at"
 
 
-class Run:
+class code:
     """
     Args:
         - Source Code
@@ -87,8 +88,11 @@ def __readStatus(self, token: str):
         Check Submission status
         """
         while True:
-            req = requests.get(API_URL + token["token"] + FIELDS)
-            self.__response = req.json()
+            req = urllib.request.Request(API_URL + token["token"] + FIELDS)
+            with urllib.request.urlopen(req) as response:
+                req = response.read()
+
+            self.__response = json.loads(req.decode("utf-8"))
             self.__memory = self.__response["memory"]
             self.__time = self.__response["time"]
             status = self.__response["status"]["description"]
@@ -108,8 +112,12 @@ def __submit(self):
         api_params["language_id"] = self.language_id
         api_params["source_code"] = self.source
 
-        res = requests.post(API_URL, data=api_params)
-        token = res.json()
+        post_data = urllib.parse.urlencode(api_params).encode("ascii")
+        req = urllib.request.Request(API_URL, post_data)
+        with urllib.request.urlopen(req) as response:
+            req = response.read()
+        token = json.loads(req.decode("utf-8"))
+
         return token
 
     def getSubmissionDate(self):
@@ -150,17 +158,24 @@ def getTime(self):
         """
         return self.__time
 
-    def getStatus(self):
+    def run(self):
         """
         submit the source code on judge0's server & return status
         """
-        if self.path:
-            if self.inp is not None:
-                self.inp = self.__readStandardInput()
-            self.source = self.__readCode()
-            self.output = self.__readExpectedOutput()
+        if os.path.exists(self.source):
+            if self.path:
+                if self.inp is not None:
+                    self.inp = self.__readStandardInput()
+                self.source = self.__readCode()
+                self.output = self.__readExpectedOutput()
 
         token = self.__submit()
-        status = self.__readStatus(token)
+        self.__token = token
+
+    def getStatus(self):
+        """
+        Return submission status
+        """
+        status = self.__readStatus(self.__token)
 
         return status

demo.py

@@ -1,17 +1,30 @@
 from coderunner import coderunner
 import pprint
 
-program_name = "testfiles/" + "test_python.py"
+source_code = "testfiles/" + "test_python_input.py"
 language = "Python"
-output = "testfiles/" + "output2.txt"
-Input = "testfiles/" + "input.txt"
-r = coderunner.Run(program_name, language, output, Input)
+output = "testfiles/output/" + "output2.txt"
+Input = "testfiles/input/" + "input.txt"
+r = coderunner.code(source_code, language, output, Input)
 
+r2 = coderunner.code("print(\"yo\")", "Python", "YO", path=False)
+
+# run the code
+r.run()
+
+print("Run r :")
 print("Status : " + r.getStatus())
-if r.getError() != None:
-	pprint.pprint("Error : " + r.getError())
+
+r2.run()
+
+print("Run r2 :")
+print("Status : " + r2.getStatus())
+
+# check if any error occured
+if r.getError() is not None:
+    pprint.pprint("Error : " + r.getError())
 else:
-	print("Standard Output : ")
-	pprint.pprint(r.getOutput())
+    print("Standard Output : ")
+    pprint.pprint(r.getOutput())
 print("Execution Time : " + r.getTime())
-print("Memory : " + str(r.getMemory()))
+print("Memory : " + str(r.getMemory()))

docs/changelog.md

@@ -1,6 +1,54 @@
 # Changelog
 
-See changelog on [GitHub](https://github.com/codeclassroom/CodeRunner/releases)
 
-## Releases
+
+## [0.5] - Dec 20, 2019
+
+### Added
+
+- New instance method - `run()`.
+- `run()` is now used to run the code i.e the code is submitted to Judge0 api using this method.
+- Support for *Bash 4.4*.
+
+### Changed
+- Renamed Class `Run` to `code` for easier usage.
+- `getStatus()`, now only returns the status in comparison to earlier versions where it performed multiple tasks.
+This is effect fixes [#2](https://github.com/codeclassroom/CodeRunner/issues/2).
+
+### Removed
+ - `requests` as a dependency, Network requests are now 50% faster.
+
+
+## [0.4] - Nov 11, 2019
+
+### Added
+
+- `getSubmissionDate()`, `getExitCode` new methods.
+- Official Documentation.
+
+### Changed
+
+- Class Run `init` - Now you can pass _source code_, _input_ and _output_ to program as strings (limited to file paths in prior versions).
+
+
+## [0.3] - Nov 9, 2019
+
+### Added
+
+- Removed redundant imports
+- Added Module/Class docstrings for documentation
+- Formatted Code
+
+
+## [0.2] - Oct 31, 2019
+
+### Changed
+
+- Fix import requests problem.
+
+
+## [0.1] - Oct 30, 2019
+- Initial Release
+
+# Releases
 See releases on [PyPi](https://pypi.org/project/coderunner/#history)

docs/index.md

@@ -1,6 +1,6 @@
 # CodeRunner 🏃
 
-> [Judge0 API](https://api.judge0.com/) Interface written in Python
+> A judge 👨🏽‍⚖️ for your programs, run and test your programs through Python
 
 [![Build Status](https://travis-ci.org/codeclassroom/CodeRunner.svg?branch=master)](https://travis-ci.org/codeclassroom/CodeRunner)
 ![PyPI](https://img.shields.io/pypi/v/coderunner?color=blue)

docs/installation.md

@@ -4,9 +4,13 @@ Installing coderunner is pretty simple, just run
 
 `pip install coderunner`
 
-or to install a specific verison 
+Install a specific verison 
 
-`pip install coderunner==0.3`
+`pip install coderunner==0.4`
+
+or directly from GitHub if you cannot wait to test new features
+
+`pip install git+https://github.com/codeclassroom/CodeRunner.git`
 
 If you have already installed it and want to update
 

docs/judge0.md

@@ -1,6 +1,6 @@
 # [judge0](https://judge0.com/)
 
-CodeRunner is powered by judge0 api.<br>
+CodeRunner is powered by Judge0 api.<br>
 
 ### [API Docs](https://api.judge0.com/)
 ### [GItHub Repository](https://github.com/judge0/api)