Getting started

Development environment


Install tools, clone the repo and run tests and examples.

sudo apt install git g++ make ccache libsqlite3-dev
git clone ssh://
sudo python -m pip install -r mys/requirements.txt
sudo python -m pip install coverage pylint
cd mys


The Mys project is built in Cygwin.

  1. Install Cygwin. Required packages are gcc-g++, make, python38, ccache, git, libtool, automake, libsqlite3-devel, wget and python38-devel.

  2. Start Cygwin and do the following one time setup.

    ln -s /usr/bin/python3.8 /usr/bin/python
    python -m easy_install pip
    git clone ssh://
    python -m pip install -r mys/requirements.txt
    python -m pip install coverage pylint
  3. Run tests and examples.

    cd mys

Tips and tricks

It’s usually a good idea to add a test in tests/files/<name>.mys and execute with make test -j 8 ARGS="-k <pattern>.

Add positive and negative tests.

Build and run all tests in parallel with make test-parallel -j 8.

Build and run all tests in parallel and all examples with make -j 8.

Open htmlcov/index.html for code coverage.

make help shows a list of all available make targets.