# Shakedown

DC/OS test harness.


## Overview

*A shakedown is a period of testing or a trial journey undergone by a ship, aircraft
or other craft and its crew before being declared operational.
    — https://en.wikipedia.org/wiki/Shakedown_(testing)*


## Installation

Given a Python 3.4 + pip + git environment,

`git clone github.com:mesosphere/shakedown.git && cd shakedown && pip install -e .`


## Usage

`shakedown --dcos_url=http://dcos.example.com [options] [path_to_tests]`

- `--dcos_url` is required.
- tests within the current working directory will be auto-discovered unless specified.
- `shakedown --help` is your friend.


## Helper methods

`shakedown` is a testing tool as well as a library.  Many helper functions are
available via `from shakedown import *` in your tests.  See the [API documentation](API.md)
for more information.


## License

Shakedown is licensed under the [Apache License, Version 2.0]. For additional
information, see the [LICENSE](LICENSE) file included at the root of this repository.


## Contributing

See the [CONTRIBUTING](CONTRIBUTING.md) file in the root of this repository.

# Shakedown

DC/OS test harness.


## Overview

*A shakedown is a period of testing or a trial journey undergone by a ship, aircraft
or other craft and its crew before being declared operational.
    — https://en.wikipedia.org/wiki/Shakedown_(testing)*


## Installation

Given a Python 3.4 + pip + git environment,

`git clone github.com:mesosphere/shakedown.git && cd shakedown && pip install -e .`


## Usage

`shakedown --dcos_url=http://dcos.example.com [options] [path_to_tests]`

- `--dcos_url` is required.
- tests within the current working directory will be auto-discovered unless specified.
- `shakedown --help` is your friend.


## Helper methods

`shakedown` is a testing tool as well as a library.  Many helper functions are
available via `from shakedown import *` in your tests.  See the [API documentation](API.md)
for more information.


## License

Shakedown is licensed under the Apache License, Version 2.0.  For additional
information, see the [LICENSE](LICENSE) file included at the root of this repository.


## Contributing

See the [CONTRIBUTING](CONTRIBUTING.md) file in the root of this repository.

Remove [] since this isn't a link
Remove [] since this isn't a link
