Skip to content

Commit 3128ffa

Browse files
coderick14coderick14
committed
Add README.rst and MANIFEST.in for PyPI
1 parent b87d41a commit 3128ffa

File tree

3 files changed

+164
-1
lines changed

3 files changed

+164
-1
lines changed

‎MANIFEST.in

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
include *.txt

‎README.md

+24-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ A command line tool to run your code against sample test cases. Without leaving
1313
+ `python setup.py install`
1414

1515
##### As a Python package
16-
`pip install ACedIt`
16+
```
17+
pip install ACedIt
18+
```
1719

1820
#### Usage
1921
```
@@ -60,6 +62,27 @@ But in case you're writing your code first and then using `ACedIt --run <source_
6062
+ Spoj
6163
+ Hackerrank
6264

65+
#### Examples
66+
+ Fetch test cases for a single problem
67+
```
68+
ACedIt -s codechef -c AUG17 -p CHEFFA
69+
```
70+
+ Fetch test cases for all problems in a contest
71+
```
72+
ACedIt -s codechef -c AUG17
73+
```
74+
+ Force download test cases, even when they are cached
75+
```
76+
ACedIt -s codeforces -c 86 -p D -f
77+
```
78+
+ Test your code against sample cases
79+
```
80+
ACedIt --run D.cpp
81+
```
82+
```
83+
ACedIt --run CHEFFA.py
84+
```
85+
6386
#### Demo
6487
![ACedIt demo GIF](https://github.com/coderick14/ACedIt/blob/master/images/demo.gif "Simple demo of how ACedIt works" )
6588

‎README.rst

+139
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
|contributions welcome| |Open Source Love| |MIT Licence|
2+
3+
.. raw:: html
4+
5+
<h1 align="center">
6+
7+
.. raw:: html
8+
9+
<img src="https://github.com/coderick14/ACedIt/blob/master/images/logo.png" width="500"/><br/>
10+
11+
.. raw:: html
12+
13+
</h1>
14+
15+
A command line tool to run your code against sample test cases. Without
16+
leaving the terminal :)
17+
18+
Installation
19+
^^^^^^^^^^^^
20+
21+
Build from source
22+
'''''''''''''''''
23+
24+
- ``git clone https://github.com/coderick14/ACedIt``
25+
- ``cd ACedIt``
26+
- ``python setup.py install``
27+
28+
As a Python package
29+
'''''''''''''''''''
30+
31+
::
32+
33+
pip install ACedIt
34+
35+
Usage
36+
^^^^^
37+
38+
::
39+
40+
usage: ACedIt [-h] [-s SITE] [-c CONTEST] [-p PROBLEM] [-f]
41+
[--run SOURCE_FILE]
42+
43+
optional arguments:
44+
-h, --help show this help message and exit
45+
-s SITE, --site SITE The competitive programming platform, e.g. codeforces,
46+
codechef etc
47+
-c CONTEST, --contest CONTEST
48+
The name of the contest, e.g. JUNE17, LTIME49, COOK83
49+
etc
50+
-p PROBLEM, --problem PROBLEM
51+
The problem code, e.g. OAK, PRMQ etc
52+
-f, --force Force download the test cases, even if they are cached
53+
--run SOURCE_FILE Name of source file to be run
54+
55+
ACedIt requires the following working directory structure.
56+
57+
::
58+
59+
root-dir
60+
|
61+
|- Site1
62+
| |- Contest1
63+
| | |- Problem1
64+
| | |- Problem2
65+
| |- Contest2
66+
| | |- Problem1
67+
| | |- Problem2
68+
|- Site2
69+
| |- Contest1
70+
| | |- Problem1
71+
72+
| During installation, ACedIt will set up the basic working directory
73+
structure.
74+
| While prefetching test cases, it will modify the same accordingly
75+
without any user intervention.
76+
| But in case you’re writing your code first and then using
77+
``ACedIt --run <source_file>``, make sure you follow the directory
78+
structure mentioned.
79+
80+
Supported sites
81+
^^^^^^^^^^^^^^^
82+
83+
- Codeforces
84+
- Codechef
85+
- Spoj
86+
- Hackerrank
87+
88+
Examples
89+
^^^^^^^^
90+
91+
- Fetch test cases for a single problem
92+
93+
::
94+
95+
ACedIt -s codechef -c AUG17 -p CHEFFA
96+
97+
- Fetch test cases for all problems in a contest
98+
99+
::
100+
101+
ACedIt -s codechef -c AUG17
102+
103+
- Force download test cases, even when they are cached
104+
105+
::
106+
107+
ACedIt -s codeforces -c 86 -p D -f
108+
109+
- Test your code against sample cases
110+
111+
::
112+
113+
ACedIt --run D.cpp
114+
115+
::
116+
117+
ACedIt --run CHEFFA.py
118+
119+
120+
Demo
121+
^^^^
122+
123+
.. figure:: https://github.com/coderick14/ACedIt/blob/master/images/demo.gif
124+
:alt: Simple demo of how ACedIt works
125+
126+
127+
Note :
128+
''''''
129+
130+
There might be some issues with Spoj, as they have widely varying DOM
131+
trees for different problems. Feel free to contribute on this. Or
132+
anything else that you can come up with :)
133+
134+
.. |contributions welcome| image:: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat
135+
:target: https://github.com/coderick14/ACedIt/issues
136+
.. |Open Source Love| image:: https://badges.frapsoft.com/os/v2/open-source.svg?v=103
137+
:target: https://github.com/coderick14/ACedIt/
138+
.. |MIT Licence| image:: https://badges.frapsoft.com/os/mit/mit.svg?v=103
139+
:target: https://opensource.org/licenses/mit-license.php

0 commit comments

Comments
 (0)