v1.0.2 (returns Output obj instead dict)

README.md

@@ -9,20 +9,30 @@ An API wrapper of online compiler jdoodle.com written in python.
 
 
 ## How to install?
-Use the following command on you device to install it.
+Install pydoodle by running 
 ```
 pip install pydoodle
 ```
 
 ### Documentation
- - Documentaion is hosted on [pydoodle.readthedocs.io](https://pydoodle.readthedocs.io) (Under development, contributions are appreciated)
+ - Documentation is hosted on [pydoodle.readthedocs.io](https://pydoodle.readthedocs.io) (Under development, contributions are appreciated)
 
 ### Example
- - A basic [example](examples/example.py) on how to use this package.
+ - Look how easy it is to use:
+
+    ```python
+    import pydoodle
+    c = pydoodle.Compiler(clientId="client-id", clientSecret="client-secret")
+    result = c.execute(script="print('Hello World')", language="python3")
+    usage = c.usage()
+    print(usage, result.output, sep='\n')
+    ```
+ - [example.py](examples/example.py) -> Basic example on how to use!
+ - [example_stdIn.py](examples/example_stdIn.py) -> Example on how to use stdIn.
 
 
 ### Misc 
- - Star this repo if you're using this wrapper 😄
+ - Star [this repo](https://github.com/Prince2347X/pydoodle/) if you're using this wrapper 😄
  - Head over to [jdoodle](https://jdoodle.com/compiler-api) to get clientId and clientSecret.
  - Read the FAQs of the API [here.](https://docs.jdoodle.com/compiler-api/compiler-api)
 

docs/source/index.rst

@@ -17,9 +17,9 @@ Look how easy it is to use:
 
     import pydoodle
     c = pydoodle.Compiler(clientId="client-id", clientSecret="client-secret")
-    output = c.execute(script="print('Hello World')", language="python3")
+    result = c.execute(script="print('Hello World')", language="python3")
     usage = c.usage()
-    print(usage, output, sep='\n')
+    print(usage, result.output, sep='\n')
 
 Features
 --------

examples/example.py

@@ -5,6 +5,6 @@
 with open(file="test1.py") as f:
     script = f.read()
     f.close()
-output = c.execute(script=script, language="python3")
+result = c.execute(script=script, language="python3")
 usage = c.usage()
-print(usage, output, sep='\n')
+print(usage, result.output, sep='\n')

examples/example_stdIn.py

@@ -1,9 +1,9 @@
-from pydoodle.jdoodle import Compiler
+import pydoodle
 
-c = Compiler(clientId="client-id",
+c = pydoodle.Compiler(clientId="client-id",
              clientSecret="client-secret")
 with open(file="test2.py") as f:
     script = f.read()
     f.close()
-output = c.execute(script=script, language="python3", stdIn="Hello World!")
-print(output)
+result = c.execute(script=script, language="python3", stdIn="Hello World!")
+print(result.output)

pydoodle/__init__.py

@@ -4,7 +4,7 @@
 # METADATA #
 ############
 
-__version__ = "v1.0.1"
+__version__ = "v1.0.2"
 __title__ = "pydoodle"
 __license__ = "MIT"
 __author__ = "Prince2347X"

pydoodle/jdoodle.py

@@ -2,6 +2,14 @@
 from .errors import *
 
 
+class Output:
+    def __init__(self, output, statusCode, memory, cpuTime):
+        self.output = output
+        self.statusCode = statusCode
+        self.memory = memory
+        self.cpuTime = cpuTime
+
+
 class Compiler:
     def __init__(self, clientId: str, clientSecret: str):
         """
@@ -29,7 +37,7 @@ def __init__(self, clientId: str, clientSecret: str):
                           'whitespace', 'yabasic']
         self.json = {}
 
-    def execute(self, script: str, language: str, stdIn: str = None, versionIndex: int = None) -> dict:
+    def execute(self, script: str, language: str, stdIn: str = None, versionIndex: int = None) -> Output:
         """
         Executes the script and return output in dict datatype.
         :param script: The script to be executed.
@@ -40,8 +48,8 @@ def execute(self, script: str, language: str, stdIn: str = None, versionIndex: i
         :type stdIn: str
         :param versionIndex: Version Index of language, defaults to 0.
         :type versionIndex: int
-        :returns: Returns a dict, having following keys(if execution is successful): "output", "statusCode", "memory", "cpuTime"
-        :rtype: dict
+        :returns: Returns an Output object.
+        :rtype: Output
         """
         if not isinstance(script, str):
             raise TypeError
@@ -67,8 +75,12 @@ def execute(self, script: str, language: str, stdIn: str = None, versionIndex: i
             else:
                 self.json["stdin"] = stdIn
         response = requests.post(url=self.base_url, headers=self.headers, json=self.json)
+        response_json = response.json()
         if response.status_code == 200:
-            return response.json()
+            return Output(output=response_json['output'],
+                          statusCode=response_json['statusCode'],
+                          memory=response_json['memory'],
+                          cpuTime=response_json['cpuTime'])
         else:
             error = response.json()
             if response.status_code == 401: