Installation

First make a virtual environment in your <PYTHONVENVS>, say ~/pyvenvs:

$ python3 -m venv <PYTHONVENVS>/typin
$ . <PYTHONVENVS>/typin/bin/activate
(typin) $

Stable release

To install typin, run this command in your terminal:

$ pip install typin

This is the preferred method to install typin, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for typin can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/paulross/typin

Or download the tarball:

$ curl  -OL https://github.com/paulross/typin/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Install the test dependencies and run typin’s tests:

(typin) $ pip install pytest
(typin) $ pip install pytest-runner
(typin) $ python setup.py test

Developing with typin

If you are developing with typin you need test coverage and documentation tools.

Test Coverage

Install pytest-cov:

(typin) $ pip install pytest-cov

The most meaningful invocation that elimates the top level tools is:

(typin) $ pytest --cov=typin --cov-report html tests/

Documentation

If you want to build the documentation you need to:

(typin) $ pip install Sphinx
(typin) $ cd docs
(typin) $ make html

The landing page is docs/_build/html/index.html.