<commit_before>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/Cal-CS-61A-Staff/ok-client.svg?branch=master)](https://travis-ci.org/Cal-CS-61A-Staff/ok-client)

## 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 .
4. Activate the virtual environment:

        source bin/activate
5. Install requirements:

        pip install -r requirements.txt

## Contributing

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

    source bin/activate

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

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:

    nosetests tests
<commit_msg>Update README with deployment instructions (resolves #82)<commit_after>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/Cal-CS-61A-Staff/ok-client.svg?branch=master)](https://travis-ci.org/Cal-CS-61A-Staff/ok-client)

## 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 .
4. Activate the virtual environment:

        source bin/activate
5. Install requirements:

        pip install -r requirements.txt

## Contributing

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

    source bin/activate

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

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:

    nosetests tests

## Deployment

To deploy a new version of ok-client, do the following:

1. Change the version number in `client/__init__.py`.
2. Make sure your virtualenv is activated. Also make sure that your `~/.pypirc`
   contains okpy's Pypi credentials.
3. From the base of the repo, make sure your virtualenv is activated and run

        python setup.py sdist upload

4. Make sure to deploy a development version locally:

        python setup.py develop

5. Create an `ok` binary:

        ok-publish

6. Draft a new release on Github with the newly created `ok` binary.
{'fraction_non_alphanumeric': 0.0906968989663221, 'fraction_numerical': 0.0106702234078026, 'mean_word_length': 3.761904761904762, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '696174', 'n_tokens_mistral': 866, 'n_tokens_neox': 822, 'n_words': 355}