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

Uploaded Source

Built Distribution

ychaos-0.5.780244-py3-none-any.whl (92.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ychaos-0.5.780244.tar.gz
  • Upload date:
  • Size: 60.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.7.12

File hashes

Hashes for ychaos-0.5.780244.tar.gz
Algorithm Hash digest
SHA256 45e52436d9e7f5a5f3a233f20c60ca6d7845051ac2ea053c229eab314a349ccc
MD5 9533d22f8f62bf2ea1582c85027428f1
BLAKE2b-256 02ce7cecf33a02fc53fd8d78453b7c6b423b054a608220fe7ae5a9aeedf67629

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ychaos-0.5.780244-py3-none-any.whl
Algorithm Hash digest
SHA256 6b20880a8faf4f82552e255e6585080d98e412f514dcf3e83e6d0040bb799e6d
MD5 fe2d73193e9be169235c05aac05b1c6d
BLAKE2b-256 948fd47152c641521b746f4b8b28573cd03a8c655d60792d2115d933352f68eb

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