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

Uploaded Source

Built Distribution

ychaos-0.5.772320-py3-none-any.whl (91.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ychaos-0.5.772320.tar.gz
  • Upload date:
  • Size: 59.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.7.12

File hashes

Hashes for ychaos-0.5.772320.tar.gz
Algorithm Hash digest
SHA256 e6b12f8f1f5d8aaead2415d8f1cd2dff67f61c524b828569cec9f474c0b39620
MD5 35956ee8b370d905f7346dff4bca1d5f
BLAKE2b-256 b8856fb7f863858b4da2c2981c1dbe9882752d61cc19dfb7a37b2f16387dae20

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ychaos-0.5.772320-py3-none-any.whl
  • Upload date:
  • Size: 91.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.7.12

File hashes

Hashes for ychaos-0.5.772320-py3-none-any.whl
Algorithm Hash digest
SHA256 acc477ef9c9570f2fb00a02d1d27d4cd35e4b2b1b45afa41c1552a7ec2ea7c84
MD5 4d36653301bd176e64c5badc5bf59542
BLAKE2b-256 d518041cc44ef11cc05ba659b981706d67890721547f6233f323200b1072be5d

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