ArchGenXML

ArchGenXML is a code generator. It builds on architecture-centric, model-based and test-driven development. Generates Python code from UML-Models (XMI-Format). It's optimized for the generation of code based on the Archetypes framework.

Project Description

With ArchGenXML you can create working python code without writing one single line of python. It is is a commandline utility that generates fully functional Zope Products based on the Archetypes framework from UML models using XMI (.xmi, .zargo, .zuml) files. The most common use case is to generate a set of custom content types, possibly with a few tools, a CMFMember type and some workflows thrown in.

In practice, you draw your UML diagrams in a tool like Poseidon or ObjectDomain which has the ability to generate XMI files. Once you are ready to test your product, you run ArchGenXML on the XMI file, which will generate the product directory. After generation, you will be able to install your product in Plone and have your new content types, tools and workflows available.

At present, round-trip support is not implemented: Custom code can't be converted back into XMI (and thus diagams). However, you can re-generate your product over existing code. Method bodies and certain "protected" code sections will be preserved. This means that you can evolve your product's public interfaces, its methods and its attributes in the UML model, without fear of losing your hand-written code.

Why should I use ArchGenXML?

Major reasons:

• You want to save time
• You are a lazy programmer
• You don't like to reinvent the wheel
• You dont like copying and pasting code and bugs
• You make heavy use of references and interfaces
• You have big projects with many different custom types
• You want or need a well-documented interface to your product
• You like structured model- and pattern-driven software development
• You want to maintain your project in future without getting a headache

and many more good and odd other reasons.

Contributors

The project was initially started by Phil Auersperg. Thanks to his laziness :-)

Authors

Phil Auersperg (Project Leader) -- "BlueDynamics Alliance, Freinberg":http://www.bluedynamics.com/, "phil@bluedynamics.com":mailto:phil@bluedynamics.com, IRC-nick: zwork;

Jens Klein (Maintainer & Release Manager, lots of code and Doc-Writer) -- "BlueDynamics Alliance, Innsbruck":http://www.bluedynamics.com/, "jens@bluedynamics.com":mailto:jens@bluedynamics.com, IRC-nick: jensens;

Reinout van Rees (Maintainer, Improvements, lots of cleanup, unit-tests) -- "Zest software":http://zestsoftware.nl/, "reinout@vanrees.org":mailto:reinout@vanrees.org, IRC-nick: reinout;

Martin Aspeli (Improvements, bug fixes and documentation) -- "Martin Aspeli":mailto:optilude@gmx.net, IRC-Nick: optilude;

Fabiano Weimar dos Santos (Ideas, Testing, Bugfixing, Workflow) -- "Weimar Desenvolvimento e Consultoria em Informatica Ltda.":http://www.xiru.org/, "xiru@xiru.org":mailto:xiru@xiru.org, IRC-Nick: Xiru,

and others -- thanks to everybody who contributed with testing, doc-writing or code-pieces!

Sponsors

• BlueDynamics Alliance, Austria
• ZestSoftware, Netherlands
• Lots of features in this code was created for and sponsored by the ZUCCARO project. ZUCCARO (Zope-based Universally Configurable Classes for Academic Research Online) is a database framework for the Humanities developed by the Bibliotheca Hertziana, Max Planck Institute for Art History For further information: "zuccaro.biblhertz.it":http://zuccaro.biblhertz.it/
• Xiru.org, Brazil (Fabiano Weimar dos Santos) sponsors a valuable amount of money into workflow support.
• PilotSystems, Paris, France (David Sapiro)
• OpenSource.ag, Innsbruck, Austria (Georg Pleger)
• Telesis.at, Austria (Jodok Batlogg)

If you want to contribute ArchGenXML by improving the code, helping with documentation or sponsoring money to make us improve it, please contact one of us.

Self-Certification

[ ] Internationalized

[X] Unit tests

[X] End-user documentation

[ ] Internal documentation (documentation, interfaces, etc.)

[X] Existed and maintained for at least 6 months

[X] Installs and uninstalls cleanly

[X] Code structure follows best practice