The ok client script (written in Python) supports programming projects by running tests, tracking progress, and assisting in debugging.
Visit http://okpy.org to use our hosted service for your course.
The ok client software was developed for CS 61A at UC Berkeley.
Clone this repo
Create a virtual environment:
virtualenv -p python3 env
Activate the virtual environment:
Install requirements and set up development environment:
pip install -r requirements.txt python3 setup.py develop
Every time you begin, you should activate the virtual environment:
All code for the client is found in the
There is an executable called
ok in the virtualenv path that will run your
code locally. You can use the example assignments in the
demo/ directory to
cd demo/ok_test ok -q q2
tests/ directory mirrors the directory structure of the
directory. Every component of the client should have plenty of tests.
To run all tests, use the following command:
Releasing an ok-client version
First make sure that
- Your virtualenv is activated and you are on the master branch.
~/.pypirccontains okpy's PyPI credentials.
- A file
.github-tokencontains a GitHub access token with the "repo" scope.
To deploy a new version of ok-client, change to the
master branch and run
vX.X.X is the new version. This will:
- Change the version number
- Create a GitHub release
- Change the ok-client version on https://okpy.org/admin/versions/ok-client
- Upload the release to PyPI