-
Notifications
You must be signed in to change notification settings - Fork 42
Developers
epai edited this page Sep 7, 2017
·
4 revisions
-
Clone this repository.
git clone https://github.com/Cal-CS-61A-Staff/ok-client.git
-
Install virtualenv
-
Create a virtualenv at the root of the repository:
virtualenv -p python3 .
Make sure your version of Python is 3.2 or above.
-
Activate the virtualenv:
source bin/activate
-
Install requirements:
pip install -r requirements.txt
All source code is found in the client/
directory.
- Models: different data types that store information about the assignment
- Configuration: the configuration file for OK
- Sources: sources from which tests are loaded
- Protocols: protocols that operate on tests
- CLI: command line interface scripts
If you use an external package (e.g. requests) and you'd like it to be bundled with the ok binary, then:
- Add it to
requirements.txt
- Add it to the
EXTRA_PACKAGES
list inclient/cli/publish.py
- Add it as an
install_requires
package insetup.py
All tests are found in the tests/
directory, which mirrors the structure of the client/
directory. Each test file corresponds to a file in client/
.
ok-client
uses Travis CI.