Development Guidelines

This repository is part of the Dask projects. General development guidelines including where to ask for help, a layout of repositories, testing practices, and documentation and style standards are available at the Dask developer guidelines in the main documentation.


After setting up an environment as described in the Dask developer guidelines you can clone this repository with git:

git clone

and install it from source:

cd dask-jobqueue
python install


When you’re done making changes, check that your changes pass flake8 checks and use black formatting:

flake8 dask_jobqueue
black dask_jobqueue

To get flake8 and black, just pip install them. You can also use pre-commit to add them as pre-commit hooks.


Test using pytest:

pytest dask_jobqueue --verbose

Test with Job scheduler

Some tests require to have a fully functional job queue cluster running, this is done through Docker and Docker compose tools. You must thus have them installed on your system following their docs.

You can then use the same commands as the CI for running the tests locally. For example for PBS you can run:

source ci/