Skip to main content

Behavior-oriented, expressive, developer-friendly assertions library

Project description

grappa logo

Build Status PyPI Coverage Status Documentation Status Stability Code Climate Python Versions

About

grappa is a behavior-oriented, self-declarative, expressive and developer-friendly lightweight assertion library for Python.

grappa comes with two declarative assertion styles: expect and should.

It also comes with a detailed, human-friendly error reporting system that aims to reduce friction and improve human agility while testing and fixing software.

To get started, take a look to the documentation and tutorial.

Status

grappa is currently beta quality software and under active development and improvements.

API is not stable yet and still prone to introduce breaking changes.

Why grappa?

grappa aims to assist humans while doing a very recurrent and not very fun task in software development: testing things.

The core idea behind grappa comes from the fact that human time is considerably more expensive than machine time, and therefore any machine assistance to optimize processes and close the gap is beneficial.

With grappa you can express almost in plain English what the test contract actually is, but in a way that’s fun and easy to write but also more easy and pleasant to read or maintain by other developers.

The Zen of grappa

  • Frictionless testing: introducing self-declarative behavior testing patterns can make testing more fun for test writers and more enjoyable for test readers.

  • Expressivity is paramount: humans should easily understand what the code is doing.

  • Human time is expensive: any modern software should assist people to identify and understand errors easily.

  • Make error reporting great again: feedback during testing is key, let’s make it more handy and less frustrating.

  • Testing patterns consolidation: software expectations are limited to the boundaries of language data types and structures.

  • Do not hurt feelings: seeing errors is not a nice thing, but it can be painless if details are showed you in a more gentle way.

Features

  • Behavior-oriented expressive Pythonic fluent API.

  • Provides both expect and should assertion styles.

  • Full-featured built-in assertions.

  • Human-friendly and frustration-less error reporting.

  • Composable assertions chaining.

  • Extensible assertions based on third-party plugins.

  • Testing framework agnostic. Works with unittest, nosetests, pytest

  • Lightweight and (almost) dependency-free.

  • Works with Python 2.6+, 3+ and PyPy.

Installation

Using pip package manager:

pip install --upgrade grappa

Or install the latest sources from Github:

pip install -e git+git://github.com/grappa-python/grappa.git#egg=grappa

History

0.1.0 (2017-03-05)

  • First version (beta)

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

grappa-0.1.0.tar.gz (29.0 kB view hashes)

Uploaded Source

Built Distribution

grappa-0.1.0-py2.py3-none-any.whl (50.6 kB view hashes)

Uploaded Python 2 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