Documentation out of date on Plume and V3 transforms

[caolan]

The documentation on using Plume recommends copying "the plume.wsgi and plume.py files from the canari/src/canari/resources/tds directory to your WSGI container’s path", but plume.wsgi doesn't exist in the repository. I found the canari install-plume command and tried that instead. The plume.sh script it generates doesn't seem to work for me so I'm running it directly: twistd web --wsgi plume.app -n.

Starting the server with the twistd command above causes Canari to report the following error:

ERROR: Plume does not support V2 Canari transforms ('Example.transforms.transform_name').
Please update to V3. See http://www.canariproject.com/4-3-transform-development-quick-start/ for more details.

However, the documentation on that page (which I originally followed) only mentions V2. Are theres docs available for V3 transforms I could review?

[allfro]

Hi Caolon,

V3 gets rid of the config import and passes it as the third parameter to
your transform. It should be the default generated transform template when
using create-transform. I will see if the documentation has references to
V3 and let you know.

Cheers

Nadeem

On Tuesday, March 24, 2015, Caolan McMahon notifications@github.com wrote:

The documentation on using Plume recommends copying "the plume.wsgi and
plume.py files from the canari/src/canari/resources/tds directory to your
WSGI container’s path", but plume.wsgi doesn't exist in the repository. I
found the canari install-plume command and tried that instead. The
plume.sh script it generates doesn't seem to work for me so I'm running
it directly: twistd web --wsgi plume.app -n.

Starting the server with the twistd command above causes Canari to report
the following error:

ERROR: Plume does not support V2 Canari transforms ('Example.transforms.transform_name').
Please update to V3. See http://www.canariproject.com/4-3-transform-development-quick-start/ for more details.

However, the documentation on that page (which I originally followed) only
mentions V2. Are theres docs available for V3 transforms I could review?

—
Reply to this email directly or view it on GitHub
#47.

[allfro]

Look at the section that's called Making Your Transforms Remote. It's 5.7.1
in the docs.

On Tuesday, March 24, 2015, Caolan McMahon notifications@github.com wrote:

The documentation on using Plume recommends copying "the plume.wsgi and
plume.py files from the canari/src/canari/resources/tds directory to your
WSGI container’s path", but plume.wsgi doesn't exist in the repository. I
found the canari install-plume command and tried that instead. The
plume.sh script it generates doesn't seem to work for me so I'm running
it directly: twistd web --wsgi plume.app -n.

Starting the server with the twistd command above causes Canari to report
the following error:

ERROR: Plume does not support V2 Canari transforms ('Example.transforms.transform_name').
Please update to V3. See http://www.canariproject.com/4-3-transform-development-quick-start/ for more details.

However, the documentation on that page (which I originally followed) only
mentions V2. Are theres docs available for V3 transforms I could review?

—
Reply to this email directly or view it on GitHub
#47.

[caolan]

@allfro thanks for the pointers. That section in the docs talks about converting to the V2 specification, don't know if that's intentional. I've already added 'config' as the third argument to dotransform and it still complains that it's not V3.

[allfro]

Do all transforms use V3?

On Wednesday, March 25, 2015, Caolan McMahon notifications@github.com
wrote:

@allfro https://github.com/allfro thanks for the pointers. That section
in the docs talks about converting to the V2 specification, don't know if
that's intentional. I've already added 'config' as the third argument to
dotransform and it still complains that it's not V3.

—
Reply to this email directly or view it on GitHub
#47 (comment).

[caolan]

I'm still not sure what V3 means... I've got rid of any config imports and using the third parameter as you suggested.

[allfro]

Hi @caolon,

V3 just means that the config imports are gone and it's passed as the third parameter. If you'd like, we can do a teamviewer session to troubleshoot the issue?