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

Uploaded Source

Built Distribution

ychaos-0.3.737737-py3-none-any.whl (86.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ychaos-0.3.737737.tar.gz
  • Upload date:
  • Size: 57.3 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.3 CPython/3.7.12

File hashes

Hashes for ychaos-0.3.737737.tar.gz
Algorithm Hash digest
SHA256 0bec41d4c235facff03fe126c49f5e87a2467068173ba3a6cb6620f0175a590b
MD5 b96cc431c1328942158e578b3f9ceee7
BLAKE2b-256 4e0c7cb756f490ef0b328cdd9f7a355ec56096bdd032f29b5e9b15a26f81246b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ychaos-0.3.737737-py3-none-any.whl
  • Upload date:
  • Size: 86.0 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.3 CPython/3.7.12

File hashes

Hashes for ychaos-0.3.737737-py3-none-any.whl
Algorithm Hash digest
SHA256 890c9603a3ac78bd2525c4593e772d687d3cca4c740fefb2683b40845080f911
MD5 8221a562cc5388f4c0945bb16af3d0c5
BLAKE2b-256 0d2af78def3097dc6e48ae0ad90ae185734a3ea14932c58e89b3d162a20861f0

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