jacquard

Split-testing server.

Installation

Jacquard can be installed through pip:

pip install jacquard-split

Alternatively it can be built from GitHub.

Documentation

Full documentation is available in ReadTheDocs.

Contributing

After cloning the repo you'll almost certainly want to install into a virtualenv in editable mode:

cd jacquard
pip install -e .

Since Jacquard requires a config file for all commands, you may also wish to export the JACQUARD_CONFIG environment variable, pointed at a suitable file.

cd jacquard
export JACQUARD_CONFIG=$PWD/config.cfg

If you're using virtualenvwrapper to manage your virtualenvs (and you probably want to be), and you've configured the virtualenv to cd to the project directory when it loads, then you can add the export line to your virtualenv's postactivate file to have it always available when you're working on Jacquard.

Running tests

Jacquard has good test coverage. A great way to check that you're up and running is to run the tests. Please ensure you also do this while developing new features as pull requests without tests (or with failing) are unlikely to be accepted.

Jacquard is tested with py.test, you can run the tests with:

python setup.py test

Linting

Jacquard uses flake8 for linting. You can install the requirements using:

pip install -r script/linting/requirements.txt

and run the linter with:

./script/linting/lint

Documenting

The docs are hosted on readthedocs and built using sphinx. The sphinx-argparse extension is also needed:

pip install sphinx sphinx-argparse
python setup.py build_sphinx

Pronounciating

Jacquard is usually pronounced in a typical English munging of the French: /'dʒæ kɑːd/ (Jack-ard). It can also be pronounced /'ʒa kaʁ/.