Skip to main content

Python module ychaos

Project description

CI Pipeline codecov Python Support PyPi Code Style Documentation License

ychaos

YChaos is a self-serving chaos testing toolkit designed to provide users with all the capabilities of doing an end to end resilience testing of your service. YChaos is designed to give users a framework to validate, verify and attack your system to simulate real life failures that might cause outages in your service.

To get started with YChaos, refer to the documentation

Table of contents

  1. Background
  2. Install
  3. Usage
  4. Maintainers
  5. License

Background

The most important aspect of maintaining a web service on cloud infrastructure is to make it resilient from failures. Most of these failures are unexpected and are not tested while development. The service which is capable of handling an unexpected failure passes the criteria of a resilient service.

YChaos provides a self-serving framework to inject these unexpected failures into your service in the form of YChaos Agents and understand if your service is equipped to handle unknown failures either within the service or from a 3rd party service dependency.

Install

To install ychaos from PyPi,

pip install ychaos[<subpackage>]

The following subpackages are available for usage

  1. agents : pip install ychaos[agents]
  2. chaos : pip install ychaos[chaos]

To know more about each subpackage and what they do, refer to the documentation

You can also install the package from the source code.

git clone https://github.com/yahoo/ychaos
cd ychaos
pip install ".[<subpackage>]"

Usage

Refer to the documentation to know about the usage.

Maintainers

The Resilience Team @yahoo

License

This project is licensed under the terms of the Apache 2.0 open source license. Please refer to LICENSE for the full terms.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ychaos-0.1.722689.tar.gz (55.0 kB view details)

Uploaded Source

Built Distribution

ychaos-0.1.722689-py3-none-any.whl (78.4 kB view details)

Uploaded Python 3

File details

Details for the file ychaos-0.1.722689.tar.gz.

File metadata

  • Download URL: ychaos-0.1.722689.tar.gz
  • Upload date:
  • Size: 55.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for ychaos-0.1.722689.tar.gz
Algorithm Hash digest
SHA256 845031f41e1aaf0b1db1e4a7c2c728b06d4a690675221b012e35f8064f1b0e72
MD5 d90db3b06c9aee94d887e059cf85a45a
BLAKE2b-256 e356e6d78ea7ef95a63aefd8976b11198dda50e6aa50c1c2e1456b8c80e0f5bc

See more details on using hashes here.

File details

Details for the file ychaos-0.1.722689-py3-none-any.whl.

File metadata

  • Download URL: ychaos-0.1.722689-py3-none-any.whl
  • Upload date:
  • Size: 78.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for ychaos-0.1.722689-py3-none-any.whl
Algorithm Hash digest
SHA256 57ea0865413c7e7ef437aa321eb54a61ac971af16764c12aaaca085c582ef678
MD5 fb8f04ce9c1692c09cfde12386dc7511
BLAKE2b-256 06f411d03856aba729dc14701f6e3eea455f9e1ef94f7c5ecc421cf8c8e58e73

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page