This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description

Checkit is a tool for validating executable specifications created with BDD style grammar. It aims to:

  1. Enable you to define BDD style specifications in python code.
  2. Provide a simple tool for validating your specifications.

To this end, checkit uses nose to enable you to create specs with keywords like “Describe”, “it” and “should”. It also provides a “checkit” command that seemlessly integrates with nose (specifically the nosetests command) to validate your software against the specs you created.

Features

  • encourages “specification by example” by promoting the use of appropriate grammar
  • uses customizable options to make nose discover and run your specs

Requirements

The requirements for using checkit are auto-installed if you use pip or easy_install.

Installation

The easiest way to install checkit is with pip install checkit or with easy_install checkit. Alternatively, you may download the source package from PyPI, extract it and install it using python setup.py install.

What you get

When you install the package, the only tangible thing you get is the “checkit” command. It uses nose to discover and execute specifications using flexible matching rules so that you are not limited to using distracting unittest (test focused) constructs like “def test…” or name your files “test…py”.

The other non-tangible benefit you get is that you no longer have to subject yourself to the unnecessary cruft needed for unittest test cases. You can now create a spec like this:

> cat coolthingy_specs.py
class DescribeCoolThingy(object):

    def it_is_cool(self):
        pass

    def it_should_not_heat_up(self):
        pass

Or even:

> cat awesomedude_specs.py
class AwesomeDudeSpecs():

    def should_smile_often(self):
        pass

Finally, when you want to validate your software against the specs, simply run the command “checkit” in your project directory like so:

> checkit
...
----------------------------------------------------------------------
Ran 3 tests in 0.006s

OK

Since checkit is merely a wrapper around nose, it accepts all the parameters that nose tipically takes. For more information, run:

> checkit --help

Feedback

I welcome any questions or feedback about bugs and suggestions on how to improve checkit. Let me know what you think about checkit. I am on twitter @RudyLattae . I appreciate constructive criticsms or high fives :)

Do you have suggestions for improvement? Then please create an issue with details of what you would like to see. I’ll take a look at it and work with you to either kill the idea or implement it.

Changelog

0.3.2b (Oct 20, 2011)

  • Add support for “given” to provide context for extra narrow tech specs.

0.3.1b (Oct 17, 2011)

  • Remove support for “examples” and “features” - focus on specs.

0.2.3b (Oct 17, 2011)

  • Refactor options passed to nose in prep to make them configurable
  • Add feature definition example
  • Add tox config to test against py2.5-2.7

0.1.0a (Jan 24, 2011)

  • First public release
  • “checkit” command to validate specs
Release History

Release History

0.3.2b

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.3.1b

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.2.3b

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.1.0a

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
checkit-0.3.2b.zip (10.0 kB) Copy SHA256 Checksum SHA256 Source Oct 21, 2011

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS HPE HPE Development Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting