Python-based Pmwiki Editor

Introduction

Scott Duff wrote a program called pmwikiedit, a Perl-based application that retrieves source from a Pmwiki site, allows the individual to edit the source using his favorite text editor, then repost the amended content back to the web server. I used that program greatly in the beginning, but when PmWiki v.2.0 came along, I found increasing difficulty with its use.

Recently, I wanted to edit pages using vim like I used to when pmwikiedit worked. I also was working on my Python skills. As I am prone to doing, I wrote the program from scratch in Python. I also sought to introduce various features that I found interesting to have.

This page helps monitor the development of this application.There is also the Cookbook:Pywe page.

Pywe is a Python-based wiki-editor that allows the user to edit PmWiki pages using his preferred text editor.

Download

• Attach:pywe-1.1.1.py Δ This is the main application.
• Attach:sample-pywerc Δ This is a sample configuration file for Pywe.

Usage

pywe [ options ] domain:Group.Pagename

pywe [ options ] http://www.example.org/pmwiki.php/Main/Sandbox

pywe --help: Will print this usage statement on the command line.

In the first example, the "domain" refers to the section of the .pywerc file that contains the wiki-specific configuration. This approach allows the editor to preset values to spare typing on the command line.

Options

-a AUTHOR, --author=AUTHOR

sets author's name from the command line

-b BROWSE,

after edit, load the page in the configured browser.

-e EDITOR, --editor=EDITOR

sets editor (full path) from the command line.

-h, --help

show this help message and exit.

-i INFILE, --infile=INFILE

edit local source and save.

-j JOURNAL, --journal

append today's date to page

-l LOCALCOPY, --localcopy=LOCALCOPY

retain local copy of page source after edit.

-n NOPASS, --nopass

site does not require a password.

-o OUTFILE, --outfile={filename}

pull source and save locally sans editing.

-u URL, --url=URL

read the PmWiki source from URI for editing.

-v VERBOSE, --verbose=VERBOSE

Not yet implemented right.

--version

show program's version number and exit

Pywerc File

The Pywerc file is an RFC 822 compliant "*.ini" file formatted configuration file. This allows the user to configure options via a configuration file such that a different set of configurations exists per domain. This is represented by the pywe [ options ] domain:Group.Pagename style of usage. The "domain" is the section delimiter in the .pywerc file. For more specific information on how it is used, please consult the sample-pywerc Δ file.

Issue Tracking

Are you aware of a problem with Pmwe? If so, please email the discussion list and state the problem. I will add it to the list of issues.

(:todolist colorize status='Open,In progress,On hold,Overdue' sort='+due':)

Journal

In order to help track the growth of this project, I will maintain a dedicated journal.

See the journal history page for more information.

Release Notes

This list tracks only the most recent five releases. Other release notes may be viewed at the main release notes page.

[[!Projects]][[!Technical]]PmWikiRecipe