Setup your environment and run the tests

Before you can start adding test coverage, you'll need to create a fork for your changes, setup your environment and run your tests.

You will be pushing changes back to the repo, so you can create a pull request and run your tests on our build servers, so you'll need to make a fork.

Fork catinabox though the github webpage, using the Fork button.

Clone your fork:

user@host:~$ git clone [email protected]:<MYUSERNAME>/catinabox.git

Create a branch and push it to your fork:

user@host:~$ cd catinabox
user@host:catinabox$ git checkout -b tutorial_wip
user@host:catinabox$ git push origin tutorial_wip

tutorial_wip is the name of the branch and can be any arbitrary string. More information on git branches is available in the github documentation.

Let's create a virtual environment so you can install packages without affecting the rest of your system. Create a virtual environment for running `catinabox``:

user@host:~/catinabox$ virtualenv catpy

Activate your virtual environment.

If you are using Linux or a Mac:

user@host:~/catinabox$ source catpy/bin/activate
(catpy)user@host:~/catinabox$

If you are on Windows:

$ .\catpy\Scripts\activate

You are now in your virtual environment, as indicated by the (catpy) prefix in your shell prompt.

"Install" catinabox to your site-packages to make sure pytest can find it.

(catpy)user@host:~/catinabox$ pip install -e .
(catpy)user@host:~/catinabox$ pip install -r test_requirements.txt

Now that you're setup, you can run the tests!

(catpy)user@host:~/catinabox$ python setup.py test

The tests pass, but why is the coverage so low? Because most of the tests are empty! You'll be filling them in during the next steps.