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

ivoire is an RSpec-like testing framework for Python. It aims to bring a few minor constructs over to Python in a way that isn’t overwhelmingly disruptive or counterculture.

In case you’ve never heard of RSpec, it’s a Ruby BDD framework that is fairly widely used, and whose tests have a style unique from xUnit’s.

Installation

Ivoire is on PyPi and can be installed via pip install ivoire (or via your preferred installation method).

At this point you should consider Ivoire to be experimental, and there are likely plenty of bugs to address, so please file them as you run into them on the issue tracker.

A Small Example

To write specs using Ivoire, simply import and use ivoire.describe. You can then execute the spec using the included ivoire test runner.

Here’s an example of what a specification looks like.

from ivoire import describe, context


class Calculator(object):
    def add(self, x, y):
        return x + y

    def divide(self, x, y):
        return x / y


with describe(Calculator) as it:
    @it.before
    def before(test):
        test.calc = Calculator()

    with it("adds two numbers") as test:
        test.assertEqual(test.calc.add(2, 4), 6)

    with it("multiplies two numbers") as test:
        test.assertEqual(test.calc.multiply(2, 3), 6)

    with context(Calculator.divide):
        with it("divides two numbers") as test:
            test.assertEqual(test.calc.divide(8, 4), 2)

        with it("doesn't divide by zero") as test:
            with test.assertRaises(ZeroDivisionError):
                test.calc.divide(8, 0)

You can find this example at examples/calculator_spec.py, alongside a few others.

After installing Ivoire, running the example above with ivoire examples/calculator_spec.py should produce:

If you’d like a more verbose output, try passing the -v command line flag.

At some point in the (hopefully very near) future, when I’ve sorted out an import hook, Ivoire will also be able to be run as ivoire transform `which nosetests` --testmatch='(?:^|[\b_\./-])[Ss]pec', which will transform specs automatically into normal unittest.TestCases. Work on this is in progress.

Running the Test Suite

Ivoire’s test suite is currently written mostly in itself, but it still has a small section that is written using the standard unittest test cases.

You can run Ivoire’s test suite by running tox in the root of the repository checkout after installing tox via your package manager or with pip install tox. This will run both parts of the suite.

Contributing

I’m Julian Berman.

You can find me on Freenode in #python-testing and various other channels (nick: tos9) if you’d like to chat, or if there’s enough interest in such a thing, in ##ivoire.

Ivoire is developed on GitHub.

Feel free to fork and submit patches or feature requests. Your contributions are most welcome!

If you’d like the best chance for them to be merged quickly try to include tests with your pull request, and adhere to general Python coding standards and your own common sense :).

Release History

Release History

0.2

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.1

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.1dev

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
ivoire-0.2.tar.gz (20.3 kB) Copy SHA256 Checksum SHA256 Source Nov 28, 2012
ivoire-0.2.zip (32.6 kB) Copy SHA256 Checksum SHA256 Source Nov 28, 2012

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