mutwo.example

This is an example for a mutwo extension package.

Making your own extension package

For making your own extension, you can clone this package:

git clone https://github.com/mutwo-org/mutwo.example

Next edit the setup.py file and replace

1. name="mutwo.example" with your extensions name
2. description="example extension for event based framework for generative art" with a description for your extension
3. url="https://github.com/mutwo-org/mutwo.example" with your project url

Don't forget to change the author and author_email arguments. Remove the hidden .git directory and make a new git project and upload it.

Adding new features

For adding new features it is the best if you adjust to mutwos internal structure and add them at the fitting submodule in mutwo. More information regarding the scope of the single modules can be found in the documentation

Adding and running tests

You can write tests using pythons buildin unittest module inside the tests directory. It may be best practice to repeat mutwos module structure inside the test directory (e.g. if you add a functionality in the generators package you should add a generators directory inside the tests directory, where you will add the respective test files).

Adding continuous integration / continuous deployment via circleci

There is already a default circleci config file at .circleci/config.yml. Make an account at circleci if you don't have any yet. Under projects select your new project and add a pipeline. If you want to publish your package at pypi you have to add the environment variables:

• TWINE_USERNAME
• TWINE_PASSWORD

with the user name and password for your pypi account. If you don't want to publish your package at pypi remove the pypi_publish job from the circleci config file.