Welcome to Python Statechart’s documentation!

Contents:

Python Statechart

Documentation Status

Python UML statechart framework

Installation

At the command line:

$ easy_install statechart

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv statechart
$ pip install statechart

Usage

To use Python Statechart in a project:

import statechart

Contributing

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 https://github.com/leighmck/statechart/issues.

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” is open to whoever wants to implement it.

Implement Features

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

Write Documentation

Python Statechart could always use more documentation, whether as part of the official Python Statechart 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 https://github.com/leighmck/statechart/issues.

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 statechart for local development.

  1. Fork the statechart repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/statechart.git

  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 statechart
$ cd statechart/
$ python setup.py 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. When you’re done making changes, check that your changes pass flake8 and the tests:

    $ flake8 statechart tests
$ py.test

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

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

  7. 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.3, 3.4 and 3.5.

Tips

To run a subset of tests:

$ py.test tests.test_statechart

Credits

Development Lead

Contributors

None yet. Why not be the first?

History

0.2.0 (2016-08-02)

  • First release on PyPI.

0.2.1 (2016-08-07)

  • Final state bug fixes.

0.2.2 (2016-08-08)

  • Default transition bug fix.

0.2.3 (2016-08-10)

  • Consume event dispatched by child state unless a final state activated.

0.2.4 (2016-08-21)

  • Fix internal transition acting like local transition.

0.3.0 (2016-10-16)

  • Implement display module to generate Plant UML code of a statechart.
  • Raise runtime exception if an action is defined on top level statechart.

0.3.1 (2016-10-16)

  • Implement specific statechart deactivate function.

Indices and tables