Skip to content

Commit abde086

Browse files
committed
new updates
- Add CHANGELOG - Removed setup.cfg - Updated Docs with changelog link - Updated requirements file.
1 parent 1b03979 commit abde086

File tree

6 files changed

+60
-15
lines changed

6 files changed

+60
-15
lines changed

CHANGELOG.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
6+
## [0.5] - Dec x, 2019
7+
8+
### Added
9+
10+
- New instance method - `run()`.
11+
- `run()` is now used to run the code i.e the code is submitted to Judge0 api using this method.
12+
- Support for *Bash 4.4*.
13+
14+
### Changed
15+
- Renamed Class `Run` to `code` for easier usage.
16+
- `getStatus()`, it now only returns the status in comparison to older versions where it performed multiple functions (submitting code on judge0 api).
17+
18+
### Removed
19+
- `requests` as a dependency, Network requests are now 50% faster.
20+
21+
22+
## [0.4] - Nov 11, 2019
23+
24+
### Added
25+
26+
- `getSubmissionDate()`, `getExitCode` new methods.
27+
- Official Documentation.
28+
29+
### Changed
30+
31+
- Class Run `init` - Now you can pass _source code_, _input_ and _output_ to program as strings (limited to file paths in prior versions).
32+
33+
34+
## [0.3] - Nov 9, 2019
35+
36+
### Added
37+
38+
- Removed redundant imports
39+
- Added Module/Class docstrings for documentation
40+
- Formatted Code
41+
42+
43+
## [0.2] - Oct 31, 2019
44+
45+
### Changed
46+
47+
- Fix import requests problem.
48+
49+
50+
## [0.1] - Oct 30, 2019
51+
- Initial Release

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,19 +31,19 @@ pip install git+https://github.com/codeclassroom/CodeRunner.git
3131

3232
import coderunner
3333

34-
program_name = "path-to/test_python.py"
34+
source_code = "path-to/test_python.py"
3535
language = "Python"
36-
output = "path-to/output.txt"
37-
Input = "path-to/input.txt"
36+
expected_output = "path-to/output.txt"
37+
standard_input = "path-to/input.txt"
3838

3939
# use this if you have a standard input to Program
40-
r = coderunner.Run(program_name, language, output, Input)
40+
r = coderunner.code(source_code, language, expected_output, standard_input)
4141

4242
# otherwise
43-
r = coderunner.Run(program_name, language, output)
43+
r = coderunner.code(source_code, language, expected_output)
4444

45-
# if not using file paths
46-
r = coderunner.Run("Hello, World", language, "Hello, World", path=False)
45+
# Use path=False if not using file paths
46+
r = coderunner.code("Hello, World", language, "Hello, World", path=False)
4747
```
4848

4949
## Documentation
@@ -81,7 +81,7 @@ pylint coderunner --disable=bad-continuation,invalid-name,too-many-instance-attr
8181

8282
## Changelog
8383

84-
Changelog can be found in [Releases](https://github.com/codeclassroom/CodeRunner/releases)
84+
Changelog can be found in [CHANGELOG.md](CHANGELOG.md)
8585

8686

8787
## Author

docs/changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Changelog
22

3-
See changelog on [GitHub](https://github.com/codeclassroom/CodeRunner/releases)
3+
See changelog on [GitHub](https://github.com/codeclassroom/CodeRunner/blob/master/CHANGELOG.md)
44

55
## Releases
66
See releases on [PyPi](https://pypi.org/project/coderunner/#history)

requirements.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
requests==2.20.0
21
isort
32
black
43
flake8

setup.cfg

Lines changed: 0 additions & 2 deletions
This file was deleted.

setup.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,6 @@
2222
'Tracker': "https://github.com/codeclassroom/CodeRunner/issues",
2323
},
2424
packages=setuptools.find_packages(),
25-
install_requires=[
26-
'requests',
27-
],
2825
classifiers=[
2926
"Programming Language :: Python :: 3",
3027
"Programming Language :: Python :: 3.6",

0 commit comments

Comments
 (0)