ok-client

KO | EN

gitlite — search

#javascript #dotfiles #java #python #ruby #nodejs #shell #hacktoberfest #c-plus-plus #vim #mantisbt-plugin #mootools

★ 57 Open GitHub ↗

A Python client for the OK autograding system

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

ok client
=========

The ok client script (written in Python) supports programming projects
by running tests, tracking progress, and assisting in debugging.

Visit [http://okpy.org](http://okpy.org) to use our hosted service for
your course.

The ok client software was developed for CS 61A at UC Berkeley.

[![Build Status](https://travis-ci.org/okpy/ok-client.svg?branch=master)](https://travis-ci.org/okpy/ok-client)
[![PyPI Version](http://img.shields.io/pypi/v/okpy.svg)](https://pypi.python.org/pypi/okpy)

## Developer Instructions

### Installation

1. Clone this repo
2. Install [virtualenv](http://docs.python-guide.org/en/latest/dev/virtualenvs/)
3. Create a virtual environment:

virtualenv -p python3 env
4. Activate the virtual environment:

source env/bin/activate
5. Install requirements and set up development environment:

pip install -r requirements.txt
        python3 setup.py develop

## Contributing

Every time you begin, you should activate the virtual environment:

source env/bin/activate

All code for the client is found in the `client/` directory.

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
play around:

cd demo/ok_test
    ok -q q2

The `tests/` directory mirrors the directory structure of the `client/`
directory. Every component of the client should have plenty of tests.
To run all tests, use the following command:

nose2

## Releasing an ok-client version

First make sure that

* Your virtualenv is activated and you are on the master branch.
* Your `~/.pypirc` contains okpy's PyPI credentials.
* A file `.github-token` contains a
  [GitHub access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/)
  with the "repo" scope.

To deploy a new version of ok-client, change to the `master` branch and run

./release.py vX.X.X

where `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

ok-client

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README