Skip to main content

Type-safe YAML-based example specification driven development framework for python.

Project description


Main branch status

Type-safe StrictYAML python integration testing framework. With this framework, your tests can:

Rewrite themselves from program output (command line test example)

Test rewriting itself

Autogenerate documentation (website test example)

Test writing docs

The tests can be run on their own or as pytest tests.

Demo projects with demo tests

Project Storytests Python code Doc template Autogenerated docs
Website add todo, correct spelling docstory.yml Add todo, Correct my spelling
REST API add todo, correct spelling docstory.yml Add todo, Correct my spelling
Interactive command line app add todo, correct spelling docstory.yml Add todo, Correct my spelling
A Python API add todo, correct spelling docstory.yml Add todo, Correct my spelling

Code Example


Logged in:
    website: /login  # preconditions
  - Form filled:
      username: AzureDiamond
      password: hunter2
  - Clicked: login

Email sent:
  about: |
    The most basic email with no subject, cc or bcc
  based on: logged in             # inherits from and continues from test above
  following steps:
  - Clicked: new email
  - Form filled:
      contents: |                # long form text
        Hey guys,

        I think I got hacked!
  - Clicked: send email
  - Email was sent

from hitchstory import BaseEngine, GivenDefinition, GivenProperty
from hitchstory import Failure, strings_match
from strictyaml import Str

class Engine(BaseEngine):
    given_definition = GivenDefinition(
    def __init__(self, rewrite=False):
        self._rewrite = rewrite

    def set_up(self):
        print(f"Load web page at {self.given['website']}")

    def form_filled(self, **textboxes):
        for name, contents in sorted(textboxes.items()):
            print(f"Put {contents} in name")

    def clicked(self, name):
        print(f"Click on {name}")
    def failing_step(self):
        raise Failure("This was not supposed to happen")
    def error_message_displayed(self, expected_message):
        """Demonstrates steps that can rewrite themselves."""
        actual_message = "error message!"
            strings_match(expected_message, actual_message)
        except Failure:
            if self._rewrite:

    def email_was_sent(self):
        print("Check email was sent!")
>>> from hitchstory import StoryCollection
>>> from pathlib import Path
>>> from engine import Engine
>>> StoryCollection(Path(".").glob("*.story"), Engine()).named("Email sent").play()
RUNNING Email sent in /path/to/working/example.story ... Load web page at /login
Put hunter2 in name
Put AzureDiamond in name
Click on login
Click on new email
Put Hey guys,

I think I got hacked!
 in name
Put in name
Click on send email
Check email was sent!
SUCCESS in 0.1 seconds.


$ pip install hitchstory


Help is available if you ask questions in these places: Github discussions | Github issues (not just for bugs) | Slack channel

Using HitchStory

Every feature of this library is documented and listed below. It is tested and documented with itself.

Using HitchStory: With Pytest

If you already have pytest set up, you can quickly and easily write a test using hitchstory that runs alongside your other pytest tests:

Using HitchStory: Engine

How to use the different features of the story engine:

Using HitchStory: Documentation Generation

How to autogenerate documentation from your tests:

Using HitchStory: Inheritance

Inheriting stories from each other:

Using HitchStory: Runner

Running the stories in different ways:

Approach to using HitchStory

Best practices, how the tool was meant to be used, etc.

Design decisions and principles

Design decisions are justified here:

Why not X instead?

HitchStory is not the only integration testing framework. This is how it compares with the others:

Using HitchStory: Setup on its own

If you want to use HitchStory without pytest:

Using HitchStory: Behavior

Miscellaneous docs about behavior of the framework:

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

hitchstory-0.24.0.tar.gz (33.0 kB view hashes)

Uploaded Source

Built Distribution

hitchstory-0.24.0-py3-none-any.whl (30.3 kB view hashes)

Uploaded Python 3

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