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.5.763359.tar.gz (58.4 kB view details)

Uploaded Source

Built Distribution

ychaos-0.5.763359-py3-none-any.whl (89.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ychaos-0.5.763359.tar.gz
  • Upload date:
  • Size: 58.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.12

File hashes

Hashes for ychaos-0.5.763359.tar.gz
Algorithm Hash digest
SHA256 7d5ea0547e266dc54399ce9db0a838161030ee40ce85d2958be5c99ca80c6228
MD5 ab4bb40b2571ac1370f5eab6ec27224c
BLAKE2b-256 0c2f10d5679c67049542296b86377aef8a1ad69e3e95b061cfe75a3ca60ad00f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ychaos-0.5.763359-py3-none-any.whl
  • Upload date:
  • Size: 89.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.12

File hashes

Hashes for ychaos-0.5.763359-py3-none-any.whl
Algorithm Hash digest
SHA256 cd2fab1d5d128c01f828ac6afb31658c98013207d7b2daa4aee02f80cdcc1f55
MD5 adecee6da148f5f7701275649cea8028
BLAKE2b-256 21b6ae81cc22d8e5067c632ffae5462b630c4e2efc4623806936c7e696905799

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