You should be able to install Empress as described in the README. However,
instead of running pip install ., please run pip install .[all]. This will
install some various dependencies needed to test Empress' python code.
You will also need to install a few Node.js packages in order to test Empress'
JavaScript code. The .travis.yml file (under the install section) shows
how to install these packages: essentially, you'll just need to run
npm install -g qunit-puppeteer jshint prettier(If you don't have npm installed, you will need to install that first.)
The Makefile contained in the root of the Empress repository is the easiest way to run Empress' tests.
You can run both the Python and JavaScript tests by running
make testIf you just want to run the Python or JavaScript tests, you can run
make pytest or make jstest respectively.
Empress' python code is linted/style-checked using flake8.
Empress' JavaScript code is linted using jshint and style-checked using
prettier.
Assuming you have these dependencies installed (see above for instructions), you can just run
make stylecheckto see if your code passes these checks.
make stylecheck will be run on Travis-CI, so it's useful to run this
periodically while developing to make sure that your code looks good (and so
you can address any issues as they come up, rather than all at once when trying
to submit a pull request).
If you'd like to ensure that make stylecheck is run automatically before you
can commit something locally -- thus ensuring that the stuff you do commit
is well-formatted -- then you can run
make githookto add on a pre-commit hook to your Empress git
repository that just runs make stylecheck.
Although some code issues (e.g. many things identified by jshint) will require
manual resolution, you can use prettier to automatically format your
JavaScript code. This can be done by just running
make jsstyle