Developers

Installation

1. Clone this repository.

    git clone https://github.com/Cal-CS-61A-Staff/ok-client.git
   

2. Install virtualenv

3. Create a virtualenv at the root of the repository:

    virtualenv -p python3 .
   

   Make sure your version of Python is 3.2 or above.

4. Activate the virtualenv:

    source bin/activate
   

5. Install requirements:

    pip install -r requirements.txt
   

Contributing

Source code

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

Using external packages

If you use an external package (e.g. requests) and you'd like it to be bundled with the ok binary, then:

1. Add it to requirements.txt
2. Add it to the EXTRA_PACKAGES list in client/cli/publish.py
3. Add it as an install_requires package in setup.py

Tests

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.