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

Uploaded Source

Built Distribution

ychaos-0.2.732444-py3-none-any.whl (84.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ychaos-0.2.732444.tar.gz
  • Upload date:
  • Size: 56.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.7.11

File hashes

Hashes for ychaos-0.2.732444.tar.gz
Algorithm Hash digest
SHA256 b12753419608c75cd7a16618bef63a9d25049aa23954e6e4359b8002e838e75d
MD5 cd662d78b19b6e89e24ecd703c5894a0
BLAKE2b-256 8b7ed44df3a16544b3681ef37564210b94c077a4e950b74d520bda011ab406e3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ychaos-0.2.732444-py3-none-any.whl
  • Upload date:
  • Size: 84.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.7.11

File hashes

Hashes for ychaos-0.2.732444-py3-none-any.whl
Algorithm Hash digest
SHA256 5f5bd1e6a45c8ce0e00a255c4e0a1d9c50414b0f11603514b9ca315bd01a580c
MD5 932c4e234cf44c0452fc4048b62e5d71
BLAKE2b-256 405ad3f093a8c69d4c5988a5b7d7f374fea28aa155bd7de2b66a5b4f063e07c7

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