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

Uploaded Source

Built Distribution

ychaos-0.5.765612-py3-none-any.whl (89.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ychaos-0.5.765612.tar.gz
  • Upload date:
  • Size: 58.7 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.765612.tar.gz
Algorithm Hash digest
SHA256 0c5bce9c727d9a2d8ba1b8d744c59b630f62dac1922cb077653c984c54459e2d
MD5 5d7a8e73318dd88bb37fad9e7c6d6f74
BLAKE2b-256 09cf5df5deea6c16372f1193febf85a634b4dc3a0a6809261dd2963565834f04

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ychaos-0.5.765612-py3-none-any.whl
  • Upload date:
  • Size: 89.8 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.765612-py3-none-any.whl
Algorithm Hash digest
SHA256 1ef9b01a5387e5f1dc11a8a556c502b6e284aeac6ea7daeae95c3ad83fbfae64
MD5 8d6d421a994485632e48e584269b2b8c
BLAKE2b-256 5ed345cbd57851a101bc9631b9ed916db3acc264a5dbd7d31578990491d9866c

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