Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

mutaprops could always use more documentation, whether as part of the official mutaprops docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up mutaprops for local development.

  1. Fork the mutaprops repo on GitHub.

  2. Clone your fork locally:

    $ git clone
  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv mutaprops
    $ cd mutaprops/
    $ python develop
  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. If you plan to work on the Java-Script part (UI front-end), you need to setup your npm environment as well. If you don’t have already, you need to get and install NPM. Once installed, in the mutaprops/web_ui directory do:

    # install dependencies
    npm install
    # serve with hot reload at localhost:8080
    npm run dev

    When using the hot reload dev server, the UI manager server (the python part) must be running on the port 9000. If you need other port numbers, adjust the mutaprops/web_ui/webpack.config.js file.

  6. When you’re done making changes, check that your changes pass flake9 and the tests, including testing other Python versions with tox:

    $ flake8 mutaprops tests
    $ python test or py.test
    $ tox

    To get flake8 and tox, just pip install them into your virtualenv.

  7. As a last step, you should build the front-end minified distribution file:

    # build for production with minification
    npm run build

    Also, if you made any changes in the mutaprops/web_ui/webpack.config.js file, don’t include them in the commit.

  1. Commit your changes and push your branch to GitHub:

    $ git add .
    $ git commit -m "Your detailed description of your changes."
    $ git push origin name-of-your-bugfix-or-feature
  2. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 3.4, 3.5 and 3.6. Check and make sure that the tests pass for all supported Python versions.


To run a subset of tests:

$ python -m unittest tests.test_mutaprops