How to install ArchGenXML and get up and running.
ArchGenXML has a dependency on some Zope 3 eggs. To avoid messing up your global site-packages directory, using buildout or virtualenv is recommended.
In an older version of AGX, a Zope 3 installation could
be configured in a
file. This case is not supported anymore. You can delete
this file if you have it.
On Windows, I assume that you installed Python 2.4.4 using
installer, and that you installed it in the default
location. If you have not already done so, configure the
environment variable to include your python path and
scripts directory. For this, go to Control Panel,
Advanced, Environment Variables, edit
Path, and append
to the existing string.
Adding the ArchGenXML egg to a Plone buildout is not supported! The Plone 3.x buildout is shipped with an old Zope 3.3. ArchGenXML depends on the latest version of Zope 3 eggs. So please create a buildout only for ArchGenXML like described below.
It can happen that the ArchGenXML version on
is older than PyPI because the release manager forgot to
upload it on
or for another reason.
will get the latest ArchGenXML version from PyPI by
default, so it's fine.
Create a fresh directory and go into it:
$ mkdir archgenxml_buildout $ cd archgenxml_buildout
Download the normal bootstrap.py and put it in this directory. You can copy an existing bootstrap.py file of one of your buildout, it's the same file.
Then create a
file in this directory with the following snippet:
[buildout] parts = archgenxml [archgenxml] recipe = zc.recipe.egg:scripts eggs = archgenxml
Is ini the appropriate lexer here?
Finally bootstrap the buildout and run it:
$ python bootstrap.py $ ./bin/buildout
On Windows, it's
bin\buildout; you have to replace '/' by '' in all following
command is now available as
To update ArchGenXML later, go in your directory and run buildout again:
It will download latest version of ArchGenXML and all its dependencies.
In the following, I refer to the
<path to archgenxml> as the
If you don't want to use buildout, you can use
to create an isolated environment. You have to install
egg in order to have the
command available. On Ubuntu you can do it with
python-setuptools. On Windows, go to the
setuptools pypi page, download the
which matches the Python version you are using, and
execute it to install it.
Install virtualenv with easy_install:
$ easy_install virtualenv
C:\Python24\Scripts, so you have to invoke it with the full path if you
haven't added this directory to your
Create the virtualenv with the
option to ignore globally-installed packages:
$ virtualenv --no-site-packages agx $ cd agx/ $ source bin/activate $ easy_install archgenxml
Every time you want use ArchGenXML, you have to go in
the agx directory and type
to activate the environment. To deactivate the
To update ArchGenXML, you have to update each egg. The
most important ones are
$ easy_install -U archgenxml $ easy_install -U xmiparser
If you have a problem with ArchGenXML, please be sure to recreate the virtualenv completely so you have the latest versions of all eggs before asking on the archetypes-users mailing-list.
I call below <path to archgenxml> the path to the virtualenv agx directory.
ArchGenXML's svn trunk is for the 2.x development version.
As usual, the goal is to keep trunk workable. Some of the developers work and develop on the edge: trunk.
If you need stability, use the latest release.
The only supported way to use the ArchGenXML trunk is with buildout. You install it like this:
$ svn co https://svn.plone.org/svn/archetypes/ArchGenXML/buildout archgenxml_buildout $ cd archgenxml_buildout $ python bootstrap.py $ bin/buildout
To update your buildout:
$ cd archgenxml_buildout $ svn up $ bin/buildout
If you are interested in AGX 3 development, see http://dev.plone.org/archetypes/browser/AGX
I call below <path to archgenxml> the archgenxml_buildout directory.
file contains information about stereotypes, fields,
and other stuff that AGX needs to generate valid
Python code from your model. You can
get the profile
Or you can regenerate it with
file is generated in the current directory.
directory and put the file here.
Note: In an older version of AGX, this file was
argouml_profile.xmi. You should not use it with ArgoUML > 0.24.
On Windows, you may have to install and configure
to compile the
egg, an indirect dependency of ArchGenXML. Now
eggs are built for Windows, so you should not have
this problem anymore.