Skip to content
The main feature flipper library and web admin application.
Python Smarty Makefile
Branch: master
Clone or download
brondsem Merge pull request #62 from switchboardpy/db/test-stability
Fix failing tests, run tests with tox
Latest commit 9015c98 Jul 12, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
debian
docs
example
switchboard
.gitignore
.travis.yml
CONTRIBUTING.md
LICENSE
MANIFEST.in
Makefile Fix failing tests, run tests with tox Jul 10, 2019
README.md Fixes a few setup-related README bugs. Apr 12, 2018
icon.svg
requirements.txt
setup.py Coverage on builtins. Jan 18, 2017
tox.ini

README.md

Build Status Code Coverage

Switchboard

Switchboard is a Python WSGI app that makes it easy to toggle features in a variety of Python web frameworks. Created to enable A/B and user testing at SourceForge, it features an easy-to-use admin dashboard with powerful conditions for activating a particular feature.

Admin Dashboard

What follows is an abbreviated version of Switchboard's full documentation.

Getting Started

Want to use Switchboard in your application? Keep reading. Interested in developing on Switchboard or running a small example locally? Take a look at the Development section.

Installing

Install Switchboard and its dependencies using pip:

pip install switchboard

Setup

Next, embed Switchboard and its admin UI within the application. Framework-specific details can be found in Switchboard's documentation.

Using Switches

Switchboard's basic unit is a switch. Every switch has a unique key associated with it and is either active (on) or inactive (off), so using it in code is simple:

>>> from switchboard import operator
>>> operator.is_active('foo')
False

In this case we checked to see if the "foo" switch was active. By default, Switchboard will auto-create any switches that don't already exist, such as "foo". Auto-created switches default to an inactive state. This just scratches the surface; there's so much more that a switch can do.

Development

These instructions cover setting Switchboard up locally for development and testing purposes. See Getting Started for notes on how to use Switchboard within a web application.

Prerequisites

  • Virtualenv: $ sudo easy_install virtualenv

Bootstrapping

  1. Make a virtualenv workspace: $ virtualenv --no-site-packages .venv
  2. Activate the virtualenv: $ source .venv/bin/activate
  3. Install all dependencies: $ make install

Running the Example App

Switchboard includes an example application, which is handy both for doing development and for taking it for a test drive in a very simple environment. It also provides an example of setting Switchboard up to run within a Bottle-based application.

To run:

$ make example

At this point a very simple application is now running at http://localhost:8080 and the admin UI is accessible at http://localhost:8080/_switchboard/. The application has one switch (example) and outputs text that tells you whether the switch is active.

Running Tests

Switchboard includes both unit tests and functional tests of the admin dashboard, using the example application.

To run the unit tests:

$ make test

The functional test requires both an updated Firefox and geckodriver:

$ npm install -g geckodriver

To run the functional tests:

$ make functional-test

Releasing

To distribute a new release of Switchboard:

  1. Update the version in setup.py, following Semantic Versioning.
  2. Cut the release:
$ make release

Versioning

We use Semantic Versioning for versioning. For the versions available, see the tags on this repository.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the Apache License - see the LICENSE file for details.

Acknowledgments

Switchboard began life as a port of Disqus' Gargoyle, a feature flipper for Django. David Cramer's Pycon lightning talk on Gargoyle had me drooling for that same feature flipping fun in non-Django apps.

You can’t perform that action at this time.