Development

This section contains information for further development of the module.

Building

Python-based scription solution Paver scripting tool solution is used to build and distribute the software. Since the package already contains the dependencies to Paver, the basic building can be done as follows

python setup.py bdist_egg sdist_src

However, installation of the paver is strongly suggested. After installation, the documentation, building and packaging can be all in once:

paver package

To build just the documentation, run:

paver doc

Testing

The unit testing in Rusty is implemented by eating the own dog food: the latest version of extensions are always used to generate content the documentation. In addition to user documentation, there exists a separate test documentation that tries the different variations of the module usage.

To run the tests (to generate the test documentation), run shell command:

python setup.py test

OR

paver test

Licensing

The software is licensed with liberal MIT license, making it suitable for both commercial and open source usage:

The MIT License

Copyright (c) 2009 Juha Mustonen

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.