Opened 12 years ago

Closed 12 years ago

Installation instructions for old-style macro

Reported by: Owned by: Brad Andrej Tokarčík normal ProgressMeterMacro minor wiki 0.11

Description

The macro looks good, nice and simple. I've installed trac plugins before, but not a macro. Nor can I find instructions anywhere on installing those not contained in a single .py file. Can this be added to your wiki page please, or at least a link to a relevant page? It would encourage adoption. Thanks

comment:1 Changed 12 years ago by Ryan J Ollos

I could be mistaken, but I think you just build an egg from the .py file and then install it as you would for any other plug-in.

comment:2 follow-up:  3 Changed 12 years ago by anonymous

Thanks rjollos.

I managed to build an egg now. Using easy_install with --install-dir to my project's plugin folder didn't seem to work (I had to export a new PYTHONPATH value prior to install to get it to accept the target directory, which maybe had something to do with it).

It did install ok in site-packages (the default) and then I had to add:

progressmeter.* = enabled


to the [components] section of trac.ini.

And now it works. Is the term 'macro' historic I wonder?

I don't feel enlightened enough to update the wiki page, but maybe someone can see where I was going wrong and write something up?

Cheers

comment:3 in reply to:  2 Changed 12 years ago by anonymous

And now it works. Is the term 'macro' historic I wonder?

Yes, I think that is correct. I read that somewhere on the Edgewall Trac site, but don't recall exactly where. I believe that macros should now be packaged and installed in the same manner that plugins are since 0.10.

comment:4 follow-up:  5 Changed 12 years ago by Ryan J Ollos

I did some more reading and if you want to install a macro for a single Trac instance (i.e. not globally), you can just put the .py file in the plugins directory. In that case, it seems there is no configuration necessary for trac.ini.

comment:5 in reply to:  4 ; follow-up:  6 Changed 12 years ago by Brad

I did some more reading and if you want to install a macro for a single Trac instance (i.e. not globally), you can just put the .py file in the plugins directory. In that case, it seems there is no configuration necessary for trac.ini.

That's if the macro/plugin is available as a single .py file. ProgressMeterMacro is deployed as a zip containing various files as required to locally build. I agree that the single .py deployment would be great. My initial comment was asking for instructions to be posted on how to do this when not a single .py file.

comment:6 in reply to:  5 Changed 12 years ago by anonymous

That's if the macro/plugin is available as a single .py file. ProgressMeterMacro is deployed as a zip containing various files as required to locally build. I agree that the single .py deployment would be great. My initial comment was asking for instructions to be posted on how to do this when not a single .py file.

I see what you are saying. So your earlier comment was implying that this should probably be named ProgressMeterPlugin rather than ProgressMeterMacro? That would make sense.

comment:7 follow-up:  8 Changed 12 years ago by Ryan J Ollos

The TicketModifiedFilesPlugin has a fairly good set of installation instruction that I have followed when installing plugins over the past several days: TicketModifiedFilesPlugin#InstallingTicketModifiedFilesPlugin

I think these are fairly widely applicable.

The TicketModifiedFilesPlugin has a fairly good set of installation instruction that I have followed when installing plugins over the past several days: TicketModifiedFilesPlugin#InstallingTicketModifiedFilesPlugin

I think these are fairly widely applicable.

Well why can't this be on a centralised Trac or Trac-Hacks wiki page, referrable by all projects? Each project could then pick the page section (or page) that's relevant for their type of install. Means less admin overhead of everyone having to maintain an install howto page, plus it is more likely to be accurate with many more people using and reviewing the same page. I'm new here so I'll leave it up to someone to do that in the right place, or close this ticket.

Cheers

comment:9 Changed 12 years ago by Andrej Tokarčík

Resolution: → fixed new → closed

Hi guys.

IIUC, macro' is *not* an obsolete term. Macros are a specific kind of plugins used to enhance wiki functionality, to insert a dynamic content into a wiki page. After all, ProgressMeterMacro presents itself as a macro plugin', which is pretty accurate.

I've put a link to TracPlugins in the ProgressMeterMacro#Installation section. The page should be referred to as the main plugin installation document Brad's been looking for.

Hopefully I can mark this issue fixed now. Thank you for collaboration.

Great, thanks

Modify Ticket

Change Properties