rest2web-develop — A discussion list for rest2web development.

Re: [Rest2web-develop] Rest2web in the wild

[Michael F. <fuz...@gm...>]

On 01/02/06, Nicola Larosa <ni...@te...> wrote:
>
> Rest2web has been spotted in the comments to this blog post:
>
> Coder Who Says Py: A web framework for a web site hosted statically
> http://sayspy.blogspot.com/2006/01/web-framework-for-web-site-hosted.html
>
> ;-)


Very nice, thank you.

Fuzzyman


--
> Nicola Larosa - http://www.tekNico.net/
>
> Using threads is like having no backups: you stay in denial
> of the problem until it bites you, and then it's too late.
> -- Nicola Larosa, November 2005
>
>
> -------------------------------------------------------
> This SF.net email is sponsored by: Splunk Inc. Do you grep through log
> files
> for problems?  Stop!  Download the new AJAX search engine that makes
> searching your log files as easy as surfing the  web.  DOWNLOAD SPLUNK!
> http://sel.as-us.falkag.net/sel?cmd=3Dlnk&kid=3D103432&bid=3D230486&dat=
=3D121642
> _______________________________________________
> Rest2web-develop mailing list
> Res...@li...
> https://lists.sourceforge.net/lists/listinfo/rest2web-develop
>



--
http://www.Voidspace.org.uk
The Place where headspace meets cyberspace. Online resource site - covering
science, technology, computing, cyberpunk, psychology, spirituality, fictio=
n
and more.

---
http://www.Voidspace.org.uk/python/index.shtml
Python utilities, modules and apps.
Including Nanagram, Dirwatcher and more.
---
http://www.fuchsiashockz.co.uk
http://groups.yahoo.com/group/void-shockz
---

Everyone has talent. What is rare is the courage to follow talent
to the dark place where it leads. -Erica Jong
Ambition is a poor excuse for not having sense enough to be lazy.
         -Milan Kundera

[Rest2web-develop] Rest2web in the wild

[Nicola L. <ni...@te...>]

Rest2web has been spotted in the comments to this blog post:

Coder Who Says Py: A web framework for a web site hosted statically
http://sayspy.blogspot.com/2006/01/web-framework-for-web-site-hosted.html

;-)

-- 
Nicola Larosa - http://www.tekNico.net/

Using threads is like having no backups: you stay in denial
of the problem until it bites you, and then it's too late.
 -- Nicola Larosa, November 2005

Re: [Rest2web-develop] Bug & feature request about file keyword in restindex

[Fuzzyman <fuz...@vo...>]

Andrew Ittner wrote:

>Fuzzyman:
>
>Regarding the timestamp, make 2 calls:
>shutil.copyfile(src, dest)
>shutil.copystat(src, dest)
>  
>
Hello Andrew,

Thanks.

I'll get it to compare timestamp *and* size, and will make the change
above. Expect this to get into SVN in the next few days.

All the best,

Fuzzyman
http://www.voidspace.org.uk/python/index.shtml

>The second method should (according to the docs) "Copy the permission bits,
>last access time, and last modification time from src to dest. The file
>contents, owner, and group are unaffected."
>
>Andrew
>
>  
>
>>-----Original Message-----
>>From: res...@li...
>>[mailto:res...@li...]On Behalf Of
>>Fuzzyman
>>Sent: Sunday, January 29, 2006 9:01 AM
>>To: res...@li...
>>Subject: Re: [Rest2web-develop] Bug & feature request about file keyword
>>in restindex
>>
>>
>>Andrew Ittner wrote:
>>    
>>
>>>(This e-mail started as part of a private exchange; per
>>>      
>>>
>>Fuzzyman's request
>>    
>>
>>>I'm posting it to the dev list.)
>>>
>>>[files get copied on every build]
>>>[snip..]
>>>
>>>	I can get rest2web to check the compare directory first
>>>      
>>>
>>though. Should it
>>    
>>
>>>check file contents or just the timestamp ?
>>>Me:
>>>Have it check the timestamp.  I don't see a need to compare
>>>      
>>>
>>file contents
>>    
>>
>>>just yet - and that may be unnecessary anyway, as I can always
>>>      
>>>
>>dump the file
>>    
>>
>>>into the output directory without using rest2web.
>>>
>>>
>>>      
>>>
>>But if copying the file changes the timestamp... then it will compare
>>differently each time. (I use ``shutil.copyfile`` I *think*.)
>>
>>Perhaps comparing contents is the thing to do...
>>
>>The other issue definitely smells like a bug. I'll fix it. :-)
>>
>>Thanks for the feedback.
>>
>>Fuzzyman
>>http://www.voidspace.org.uk/python/index.shtml
>>    
>>
>
>
>
>
>-------------------------------------------------------
>This SF.net email is sponsored by: Splunk Inc. Do you grep through log files
>for problems?  Stop!  Download the new AJAX search engine that makes
>searching your log files as easy as surfing the  web.  DOWNLOAD SPLUNK!
>http://sel.as-us.falkag.net/sel?cmd=lnk&kid=103432&bid=230486&dat=121642
>_______________________________________________
>Rest2web-develop mailing list
>Res...@li...
>https://lists.sourceforge.net/lists/listinfo/rest2web-develop
>
>  
>

RE: [Rest2web-develop] Bug & feature request about file keyword in restindex

[Andrew I. <and...@us...>]

Fuzzyman:

Regarding the timestamp, make 2 calls:
shutil.copyfile(src, dest)
shutil.copystat(src, dest)

The second method should (according to the docs) "Copy the permission bits,
last access time, and last modification time from src to dest. The file
contents, owner, and group are unaffected."

Andrew

> -----Original Message-----
> From: res...@li...
> [mailto:res...@li...]On Behalf Of
> Fuzzyman
> Sent: Sunday, January 29, 2006 9:01 AM
> To: res...@li...
> Subject: Re: [Rest2web-develop] Bug & feature request about file keyword
> in restindex
>
>
> Andrew Ittner wrote:
> > (This e-mail started as part of a private exchange; per
> Fuzzyman's request
> > I'm posting it to the dev list.)
> >
> > [files get copied on every build]
> > [snip..]
> >
> > 	I can get rest2web to check the compare directory first
> though. Should it
> > check file contents or just the timestamp ?
> > Me:
> > Have it check the timestamp.  I don't see a need to compare
> file contents
> > just yet - and that may be unnecessary anyway, as I can always
> dump the file
> > into the output directory without using rest2web.
> >
> >
> But if copying the file changes the timestamp... then it will compare
> differently each time. (I use ``shutil.copyfile`` I *think*.)
>
> Perhaps comparing contents is the thing to do...
>
> The other issue definitely smells like a bug. I'll fix it. :-)
>
> Thanks for the feedback.
>
> Fuzzyman
> http://www.voidspace.org.uk/python/index.shtml

Re: [Rest2web-develop] Bug & feature request about file keyword in restindex

[Fuzzyman <fuz...@vo...>]

Andrew Ittner wrote:
> (This e-mail started as part of a private exchange; per Fuzzyman's request
> I'm posting it to the dev list.)
>
> [files get copied on every build]
> [snip..]
>
> 	I can get rest2web to check the compare directory first though. Should it
> check file contents or just the timestamp ?
> Me:
> Have it check the timestamp.  I don't see a need to compare file contents
> just yet - and that may be unnecessary anyway, as I can always dump the file
> into the output directory without using rest2web.
>
>   
But if copying the file changes the timestamp... then it will compare
differently each time. (I use ``shutil.copyfile`` I *think*.)

Perhaps comparing contents is the thing to do...

The other issue definitely smells like a bug. I'll fix it. :-)

Thanks for the feedback.

Fuzzyman
http://www.voidspace.org.uk/python/index.shtml

[Rest2web-develop] Bug & feature request about file keyword in restindex

[Andrew I. <and...@us...>]

(This e-mail started as part of a private exchange; per Fuzzyman's request
I'm posting it to the dev list.)

[files get copied on every build]
I noticed that if I use the "file" keyword in the restindex, the file gets
copied every time, which resets its datetime stamp, which makes sitecopy
(webdav site uploader, http://www.lyra.org/sitecopy/) think it is a new
file, so the file gets uploaded every time.

I know I can just deposit the file in the output directory once and not
reference it in the rest2web source, but I want to keep my "build" files in
one place.  Can you make the file keyword work like building from source:
only copy the file if it is newer than the destination?

Fuzzyman's response:
	'file' is one of the features I don't use, I added it as a feature request
for someone else.

	I can get rest2web to check the compare directory first though. Should it
check file contents or just the timestamp ?

Me:
Have it check the timestamp.  I don't see a need to compare file contents
just yet - and that may be unnecessary anyway, as I can always dump the file
into the output directory without using rest2web.

[file, path]
I have several file= keywords in my root index, like so:
    file: rp.css
    file: rplogo.png
    file: halloffamelogo.png

I have another file= keyword in my projects/rest2web/restandmacros.txt,
pointing to itself (that's my rest-and-html-and-macros playground, so I want
others to see the actual source file), but the keyword
	file: restandmacros.txt
in it fails with this error:

Traceback (most recent call last):
[err]   File "/home/aji/code/dev/rest2web/r2w.py", line 171, in ?
[err]     count = main(config)
[err]   File "/home/aji/code/dev/rest2web/r2w.py", line 104, in main
[err]     return processor.walk()
[err]   File "/home/aji/code/dev/rest2web/rest2web/restprocessor.py", line
244, in walk
[err]     subdir=subdir)
[err]   File "/home/aji/code/dev/rest2web/rest2web/restprocessor.py", line
640, in process
[err]     copyfile(src, dest)
[err]   File "/usr/lib/python2.4/shutil.py", line 47, in copyfile
[err]     fsrc = open(src, 'rb')
[err] IOError: [Errno 2] No such file or directory: 'restandmacros.txt'

I have to specify the full path:
    file: /home/aji/www/rpinput/projects/rest2web/restandmacros.txt
to get the file copied over.

This happens whether the file is the page's source or not (just in case
rest2web didn't like handling the same file twice).  So there's a difference
between the file keyword usage in the root and in subdirectories.

Fuzzyman:
	Ok - that sounds like a bug (maybe it's a feature...).

	I don't *fully* understand though. Are you saying this is in the root
directory, and other files specified in the same source file *work*, but
this one doesn't ?

	How can I reproduce this bug ?

Me:
A file referenced in the root's index.txt, that resides in the same
directory, gets copied over fine.  A file referenced in a subdirectory's
index.txt, that resides in that same subdirectory, generates the error *if
the full path is not specified*.

To answer your question specifically, all the files in the root's index.txt
get copied over fine; the file in the subdirectory's index.txt does not.

REPRO:
I use rest2web on a Linux machine, if that makes a difference regarding
paths and such.

- in the site root's index.txt, add "file: fromroot.txt" to the restindex
section
- make a subdirectory, add a normal index.txt with a restindex section
there, and add "file: fromsub.txt" to the restindex
- make sure fromroot.txt and fromsub.txt exist
- run r2w.py, pointing to the ini that will build the site
- ???
- profit!  (Sorry, wait, no, that's not right...)

Let me know if you need clarifications, more repro steps (especially that
"???" step, that can be a doozy), etc.

Andrew Ittner

[Rest2web-develop] More rest2web bugs & feature requests

[Andrew I. <and...@us...>]

(This e-mail started as part of a private exchange; per Fuzzyman's request
I'm posting it to the dev list.  My original e-mail is bracketed.)

> [quiet]
> When running r2w.py, a setting to only print a line about built files
would
> be nice, similar to a "--quiet" option.
>

Ok, I can use the 'verbosity' feature of standout and let the user set a
verbosity level in the config file.

> [ini error message]
> When r2w.py is called without an ini file, there's a traceback message and
> then the error explanation:
> Traceback (most recent call last):
>   File "/home/aji/code/dev/rest2web/r2w.py", line 145, in ?
>     config = ConfigObj(cfg_file, file_error=True)
>   File "/home/aji/code/dev/rest2web/pythonutils/configobj.py", line 873,
in
> __init__
>     raise IOError, 'Config file not found: "%s".' % self.filename
> IOError: Config file not found: "/home/aji/dl/rest2web.ini".
>
> That's a little intimidating for a first-time user, and I tend to read the
> traceback and get sidetracked before I reach the last line, which tells me
> what the problem is.  Can you kill the traceback and just output the
IOError
> message to make the error stand out?
>

Ok, no problem.

-=-
Thanks,

Andrew

[Rest2web-develop] rest2web & Another terrible Idea

[<fuz...@vo...>]

{emo;waffle} As I mentioned I've been hacking on `rest2web </python/rest2web/>`_ a bit.

I've started to add the functionality that will make *Next* and *Previous* links possible for pages.

Some of what I'd like to do, specifically auto-building contents pages that include the directories *below* the current one, would require changing **rest2web** to a two pass build system.

In the first pass accumulate all the data & metadata for pages, *then* build them all.

It occurs to me that this would be an opportunity to savagely refactor. Currently **rest2web** builds datastructures that represent the directories / section / site. These are all built with nested list and dictionary datatypes.

When generating the {acro;HTML} output it has to regenerate these data structures virtually for every page. This is because each page can have a target location that is actually outside of the directory being built. **rest2web** needs to recalculate relative links from the current page to every other location. (It also handles making sure that the information about each page is available in the *output encoding* of the page being handled. This means you can use several different output encodings throughout your site.)

This has the great advantage that you aren't tied to the directory structure that **rest2web** uses to represent sites. `Voidspace </index2.shtml>`_ uses this facility. It allows you to include in indexes, pages that are actually somewhere else in the site. For example the `Library Pages </library/index.shtml>`_ are included in the `Cyberpunk </cyberpunk/index.shtml>`_ section. The template code for the index page is trivially simple.

Recalculating these each time is expensive, and makes the code very fiddly (i.e. difficult to understand). It would be better to generate a tree structure for the site, with custom objects representing the pages and indexes. It would make the code simpler, but it would mean replacing the `indextree data structure </rest2web/reference/indextree.html>`_ with something more useful. Hmm...... {sm;:neutral:}

This of course is a *terrible idea*. Making the code more readable, and more useful, is *good* - but it's a lot of work.

.. note::

    In practise it may not have that much effect. The relative paths would *still* need to be calculated. A custom object could *possibly* do this conversion on demand though.

[Rest2web-develop] rest2web in Action

[<fuz...@vo...>]

{emo;eyeballz} `rest2web </python/rest2web/>`_ has a new user, *Andrew Ittner*.

Thanks to his suggestions I'm adding a couple of new ways to display the time/date a page was modified. More exciting changes to follow soon, I promise. {sm;:biggrin:}

I'm also updating the docs. I have compiled a list of sites (all the ones I'm aware of) that use **rest2web** :

* `Voidspace <http://www.voidspace.org.uk/index2.shtml>`_
* `Rhyming Panda <http://www.rhymingpanda.com>`_
* `The Python Acadamy <http://www.python-academy.de/>`_
* `Website of Marius Soutier <http://www.soutier.de>`_
* `CreaText <http://creatext.sourceforge.net/>`_
* `Tibed.net Game Site <http://www.tibed.net/>`_
* `Website of Peter Brett <http://peter-b.co.uk/>`_
* `Website of Paul Bartletts <http://bartletts.pwp.blueyonder.co.uk>`_
* `Docs for PyGeo <http://pygeo.sourceforge.net/docs_html/>`_

I also use it to build the docs for :

* `Movable Python </python/movpy/>`_
* rest2web_

Now does anyone want to take pity on me and create a better HTML template for **rest2web** and **Movable Python** ? {sm;?:}

If you fancy the task, the template is in the **rest2web** distribution (*template.txt* in the docs folder).

[Rest2web-develop] SVN Repository (rest2web and pythonutils)

[<fuz...@vo...>]

{emo;baldguy} The `SVN Repository <https://svn.rest2web.python-hosting.com/>`_ is now up to date (again).

This is for `rest2web <http://www.voidspace.org.uk/python/rest2web/>`_ and `pythonutils <http://www.voidspace.org.uk/python/modules.shtml#pythonutils>`_.

Because of my work situation (restricted internet), I am only able to update once a week (time permitting), so it has lagged behind recently.

The **rest2web** docs in SVN are in a state of disarray. This is because I am updating them. All will be well again soon. {sm;:-)}

Whilst explaining to a friend how `Firedrop2 <http://www.voidspace.org.uk/python/firedrop2/>`_ could act as a front-end to rest2web, I realised how feasible this actually is. The main requirement would be a tree widget for the sidebar, that gives you access to all the source files in your site.

A nice GUI widget to create the restindex for each page would also be nice - and not very difficult. This would provide a nice graphical way of editing sites and creating new pages.

The first priority is to get contents pages auto-built. First things first...

Re: [Rest2web-develop] Python(like) Documentation in reST

[Fuzzyman <fuz...@vo...>]

Peter TB Brett wrote:

>fuz...@vo... wrote:
>
>  
>
>>This means that it would be possible to create Python-like documentation
>>using **rest2web**. The only limtiation is that site are built *top down*,
>>so directories wouldn't have easy access to the contents of directories
>>below them. Building large contents pages that include subdirectories
>>wouldn't be possible (yet).
>>    
>>
>
>...but it would be a very, *very*, **very** useful feature.
>
>  
>
The only way to do it would be to make rest2web a two pass process. In
the first pass build all the structures (which includes contents
information).

In the second pass build the pages. This means every page would have
access to the information about all the other pages. This would allow
some funky collapsing javascript indexes, showing the entire site structure.

It would also be a good opportunity to implement a nice caching
mechanism that only has to parse/rebuild pages that have changed (or
where the templates have changed).

This wouldn't actually be *that* big a deal to implement. Extracting
contents information from docutils (by accessing the data structure
created by the ``.. contents::`` directive) would be *interesting* - but
probably achievable. What to do with html pages, or pages that don't use
``.. contents::`` is another question.

It still leaves the 'index' question unsolved, building a contents page
is one thing. Marking items for inclusion in an index is something else
I would like to do, but am not sure how (macro with global data
structure ?).

Also - as a single developer (hint!) this will have to fit in with the
other projects I'm working on.

I'm currently working on :

* New version of Movable Python - might generate some income so a high
priority
* New release of the guestbook which includes the akismet anti-spam
* New *version* of the guestbook with web admin interface for easy
deletion/editing of entries
* Release of skimpy the Python search engine

So.... it rest2web will have to fit in with these. :-)

The rest2web source code is very well commented if you fancy having a
poke around inside.

Seasons greetings...

Fuzzyman
http://www.voidspace.org.uk/python/index.shtml

>Peter ;)
>
>
>--
>Quake II build tools: http://peter-b.co.uk/
>Latest QuArK:         http://quark.sourceforge.net/LatestVersion
>
>v2sw6YShw7ln5pr6ck3ma8u7Lw3+2m0l7CFi6e4+8t4Eb8Aen4g6Pa2Xs5MSr5p4
>  hackerkey.com
>
>
>
>-------------------------------------------------------
>This SF.net email is sponsored by: Splunk Inc. Do you grep through log files
>for problems?  Stop!  Download the new AJAX search engine that makes
>searching your log files as easy as surfing the  web.  DOWNLOAD SPLUNK!
>http://ads.osdn.com/?ad_id=7637&alloc_id=16865&op=click
>_______________________________________________
>Rest2web-develop mailing list
>Res...@li...
>https://lists.sourceforge.net/lists/listinfo/rest2web-develop
>
>  
>

Re: [Rest2web-develop] Python(like) Documentation in reST

[Peter TB B. <pe...@pe...>]

fuz...@vo... wrote:

> This means that it would be possible to create Python-like documentation
> using **rest2web**. The only limtiation is that site are built *top down*,
> so directories wouldn't have easy access to the contents of directories
> below them. Building large contents pages that include subdirectories
> wouldn't be possible (yet).

...but it would be a very, *very*, **very** useful feature.

Peter ;)


--
Quake II build tools: http://peter-b.co.uk/
Latest QuArK:         http://quark.sourceforge.net/LatestVersion

v2sw6YShw7ln5pr6ck3ma8u7Lw3+2m0l7CFi6e4+8t4Eb8Aen4g6Pa2Xs5MSr5p4
  hackerkey.com

[Rest2web-develop] Python(like) Documentation in reST

[<fuz...@vo...>]

{acro;html} I like the `reST <http://docutils.sourceforge.net>`_ plain text markup format. You might guess that from my `rest2web <http://www.voidspace.org.uk/python/rest2web/>`_ project, which allows me to maintain my website in {acro;reST;reStructuredText} [#]_.

There has been some discussion about developing the Python documentation in reST. Unfortunately it seems that reST, as a plain-text format, is unlikely to ever develop the complexity needed to replace LayTeX as the python documentation format [#]_.

That aside, it would still be nice to have a tool that built docs that *look* like the Python documentation from reST sources. The Python documentation is very attractive, and the '**Next**', '**Previous**, and '**Up**' blue arrows make them very usable as well.

`rest2web`_ now has a way of specifying page order in a directory (and section) - the ``section-pages`` keyword in the `restindex </python/rest2web/restindex.html>`_.

It occurs to me that this means it should be easy enough to provide each page with links to it's  '**Next**', '**Previous**, and '**Up**' pages within it's namespace.

If I can extract the page contents from docutils (I have some example code to do this), then it should be possible to autobuild full contents pages for a directory as well. 
Unfortunately, splitting larger documents down into several pages is probably beyond me (until docutils provides a way of doing it anyway).

This means that it would be possible to create Python-like documentation using **rest2web**. The only limtiation is that site are built *top down*, so directories wouldn't have easy access to the contents of directories below them. Building large contents pages that include subdirectories wouldn't be possible (yet).

.. [#] It also allows you to keep content as {acro;HTML}, so it can be used as a templating system (that will autobuild index pages) for *any website* - without requiring you to use **reST**.
.. [#] Specifically, a syntax to mark functions and arguments *and* build indexes from this data, is required.

[Rest2web-develop] [Fwd: Emailing: rest2web140.gif]

[Fuzzyman <fuz...@vo...>]

Here is a smaller logo - for those who might prefer to use it.

Don't forget to link it to http://www.voidspace.org.uk/python/rest2web/

;-)

Fuzzyman
http://www.voidspace.org.uk/python/index.shtml

-------- Original Message --------
Subject: 	Emailing: rest2web140.gif
Date: 	Thu, 15 Dec 2005 14:49:12 +0000
From: 	Venturer <fuc...@gm...>
To: 	Fuzzyman <fuz...@vo...>



The message is ready to be sent with the following file or link 
attachments:
rest2web140.gif

Note: To protect against computer viruses, e-mail programs may prevent 
sending or receiving certain types of file attachments. Check your 
e-mail security settings to determine how attachments are handled.

-- 
Fuchsia Shockz!
Articles and news magazine on Cyberpunk, Science and Technology and weird phenomena and mysteries.
http://www.fuchsiashockz.co.uk

[Rest2web-develop] [Fwd: Emailing: rest2web200x80.gif]

[Fuzzyman <fuz...@vo...>]

Hello all,

A friend (Justin of `Fuchsiashock <http://www.fuchsiashock.co.uk>`_) has
done a "powered by rest2web" logo. It's 200x80 pixels, and very stylish.

-------- Original Message --------
Subject: 	Emailing: rest2web200x80.gif
Date: 	Thu, 15 Dec 2005 12:28:15 +0000
From: 	Venturer <fuc...@gm...>
To: 	Fuzzyman <fuz...@vo...>



The message is ready to be sent with the following file or link 
attachments:
rest2web200x80.gif

-- 
Fuchsia Shockz!
Articles and news magazine on Cyberpunk, Science and Technology and weird phenomena and mysteries.
http://www.fuchsiashockz.co.uk

Re: [Rest2web-develop] rest2web Users

[Peter B. <pe...@pe...>]

On Thursday 01 December 2005 15:20, Fuzzyman wrote:

> I'm compiling a list of rest2web users for the rest2web documentation -
> just example sites.

You can include my personal site if you want: http://peter-b.co.uk/

...I'd recommend a paragraph at the bottom of the page saying, "Several people 
are using rest2web to maintain their personal websites... yadayadayada"

Peter

-- 
Quake II build tools:  http://peter-b.co.uk/
Latest QuArK:          http://quark.sourceforge.net/LatestVersion

v2sw6YShw7ln5pr6ck3ma8u7Lw3+2m0l7CFi6e4+8t4Eb8Aen4g6Pa2Xs5MSr5p4
  hackerkey.com

[Rest2web-develop] rest2web Users

[Fuzzyman <fuz...@vo...>]

Hello all,

I'm compiling a list of rest2web users for the rest2web documentation -
just example sites.

If you would like me to include your site then please let me know the
URL I should include (and any brief description).

This would be very helpful for me. I currently know of six sites built
with rest2web (plus voidspace of course).

Also - if there are features you would like to see, or suggestions you
have, could you post them to the mailing list.

Many Thanks

Fuzzyman
http://www.voidsapce.org.uk/python/index.shtml

[Rest2web-develop] rest2web 0.4.0 alpha

[<mi...@pc...>]

{emo;html} **rest2web** `0.4.0 alpha </python/rest2web/>`_ is now available for 
download. After about five months (and lots of changes), I've finally done a
new release.

This means :

* The `gallery </python/rest2web/reference/gallery.html>`_ plugin is now included [#]_
* There is also a windoze executable available [#]_
* The `new tutorial </python/rest2web/tutorial.html>`_ is online.

There have been *lots* of `changes </python/rest2web/reference/changelog.html#version-0-4-0-alpha-2005-11-11>`_
since **0.3.0**.

The documentation has been greatly improved. The tutorial means that anyone 
wanting to use **rest2web** to create a site should be able to get up to speed
on the basics very quickly.

You can see a sample output from the gallery over at `Example Gallery </python/rest2web/gallery_test/index.html>`_.

.. [#] The gallery plugin will work as a standalone program to generate static
       html gallery pages.
.. [#] The gallery plugin doesn't yet work with the executable.

[Rest2web-develop] rest2web Progress

[<mi...@pc...>]

{emo;html} The new standard functions and *lots* of docs changes are now in **rest2web** SVN__.

I still haven't been able to cleanup the plugin API to my satisfaction. However, the doc refactor is nearly complete.

The version of **rest2web** in subversion has so many improvements over the 0.3.0 release that I'm going to do an interim **0.4.0 alpha** release. This will allow me to get the new documentation online - and should hit the streets any day now.

__ http://svn.rest2web.python-hosting.com

[Rest2web-develop] ConfigObj in Bazaar

[<mi...@pc...>]

{emo;envelope} A couple (or so) of pieces of ConfigObj__ related news.

I've just discovered that ConfigObj is in bazaar__ 0.6 (*the* Python  distributed {acro;VCS;Version Control System}). It's used to read ``bazaar.conf`` and ``branches.conf``.

This is a high profile project - so it's nice to see ConfigObj being used.

http://bazaar-ng.org/bzr/bzr.dev/NEWS

ConfigObj continues to be pretty popular - ConfigObj and pythonutils__ (which contains ConfigObj) get at least ten downloads a day via voidspace [#]_. Based on my own habits I use about one in thirty of the interesting code/projects that I download. That means a new user every three days.

I've also just received and squashed a bug report. There was a bug in the ``walk`` section method - if you use walk to change member names. It's now fixed. {sm;:-)}

It's highlighted  a nice use-case for walk, which I wasn't sure if anyone would use at all. You can create a template config file with placeholders in names and values. When you need to create a new config file (E.g. to add a new user to an application) you can use ``walk`` to replace the placeholders with appropriate values in member names, section names, and values.

.. raw:: html

    {+coloring}

    # We use 'XXXX' as a placeholder
    # config is our template config file
    config = '''
    XXXXkey1 = XXXXvalue1
    XXXXkey2 = XXXXvalue2
    XXXXkey3 = XXXXvalue3
    [XXXXsection1]
    XXXXkey1 = XXXXvalue1
    XXXXkey2 = XXXXvalue2
    XXXXkey3 = XXXXvalue3
    [XXXXsection2]
    XXXXkey1 = XXXXvalue1
    XXXXkey2 = XXXXvalue2
    XXXXkey3 = XXXXvalue3
        [[XXXXsection1]]
        XXXXkey1 = XXXXvalue1
        XXXXkey2 = XXXXvalue2
        XXXXkey3 = XXXXvalue3
    '''.splitlines()
	#
	# create a config object
	# normally we'd read from a file to do this
    cfg = ConfigObj(config)
    #
    # this is our function that does replacement
    # in the config file
    def transform(section, key):
        val = section[key]
	# change the member name
        newkey = key.replace('XXXX', 'CLIENT1')
        section.rename(key, newkey)
        if isinstance(val, (tuple, list, dict)):
            pass
        else:
	    # change the value - only if it isn't
	    # a section (dict) or a list value
            val = val.replace('XXXX', 'CLIENT1')
            section[newkey] = val
    #
    cfg.walk(transform, call_on_sections=True)
    print cfg
    {'CLIENT1key1': 'CLIENT1value1', 'CLIENT1key2': 'CLIENT1value2', 
    'CLIENT1key3': 'CLIENT1value3', 
    'CLIENT1section1': {'CLIENT1key1': 'CLIENT1value1', 
        'CLIENT1key2': 'CLIENT1value2', 'CLIENT1key3': 'CLIENT1value3'}, 
    'CLIENT1section2': {'CLIENT1key1': 'CLIENT1value1', 
        'CLIENT1key2': 'CLIENT1value2', 'CLIENT1key3': 'CLIENT1value3', 
        'CLIENT1section1': {'CLIENT1key1': 'CLIENT1value1', 
            'CLIENT1key2': 'CLIENT1value2', 'CLIENT1key3': 'CLIENT1value3'}}}
    # all the occurences of 'XXXX' have been changed
   
    {-coloring}

(Thanks to M. Gehling for the bug report).

I've added an ``istrue`` section method. This will fetch string values as booleans. The following are interpreted as ``True`` (not case sensitive) : ::

    true, yes, on, 1

The following are ``False`` : ::

    false, no, off, 0

Anything else raises a ``ValueError``.

We have also *finally* [#]_ resolved the issue with ``list_values=False``. This is when **ConfigObj** doesn't parse values as list values. Previously when unquoting it could do the wrong thing. The quoting and unquoting was also causing a user some problems.

I've settled on a behaviour which solves both problems in one go. There is now a note in the docs which explains it :

The ``list_values`` attribute [and option] is ``True`` or ``False``. If set to ``False`` then values are not parsed for list values. In addition single line values are not unquoted.

This allows you to do your own parsing of values. It exists primarily to support the reading of the `configspec </python/configobj.html#configspec>`_ - but has other use cases.

For example you could use the ``LineParser`` from `listquote </python/listquote.html#lineparser>`_ to read values for nested lists.

Single line values aren't quoted when writing - but multiline values are handled as normal.

.. caution::

    Because values aren't quoted when writing, leading or trailing whitespace can be
	lost.

    This behaviour was changed in version 4.0.1.
	
	Prior to this, single line values might have been quoted; even with
	``list_values=False``. This means that files written by **ConfigObj**
	*could* now be incompatible - and need the quotes removing by hand.


These changes are in the **ConfigObj 4.0.1** release.

-----

.. [#] Plus more from PyPi__, sourceforge__, gentoo-portage__, etc. {sm;:biggrin:}
.. [#] Well I hope finally, so long as no-one objects to the change. {sm;:neutral:}

__ /python/modules.shtml#configobj
__ http://bazaar-ng.org
__ /python/pythonutils.html


__ http://cheeseshop.python.org/pypi/pythonutils
__ http://sf.net/projects/configobj
__ http://packages.gentoo.org/packages/?category=dev-python;name=pythonutils

[Rest2web-develop] rest2web Update Edges Closer

[<mi...@pc...>]

{emo;knot} I've just committed a set of changes to `rest2web SVN`__.

They're *mainly* documentation changes - I'm about half way through the refactor, including three quarters of the way through the tutorial. This means that some links between pages *don't work from SVN*, but at least some of the updated information is now available.

I've also added two new *standard functions*. You can now print an index page for a directory with a single function call. (Without having to worry about escaping of {acro;URL;Uniform Resource Locator}s).


.. [#] ...and documented {sm;:-p}

__ https://svn.rest2web.python-hosting.com/trunk/

[Rest2web-develop] Re: rest2web (question)

[Fuzzyman <fuz...@vo...>]

Hello Wolfgang,

I'm glad you're trying out rest2web. I'm putting a bit of work into it
at the moment.

-----Original Message-----
>From: "Wolfgang Buechel"<wj...@we...>
>Sent: 22/10/05 00:34:16
>To: "Fuzzyman"<fuz...@vo...>
>Subject: rest2web (question)
>
>Hello again,
>
>I observed that the topics in the sidebar on the left are shown in
>the same order as the files in the directory, or am I wrong?
>
>Is there a way to arrange them in another order?
>

You're correct - they're basically in an 'arbitrary' order, which turns
out to be the order of the files in the directory.

In the version in SVN there is a way to set this order - but it's
currently undocumented. It's one of the features of the forthcoming
0.4.0 release and I'm working on the docs.

This is the new 'section-pages' keyword in the restindex (of the
relevant index page). 'section-pages' sets the order of pages within
each section. The order of sections obviously follows the 'sectionlist'
keyword.

To set the order of pages in the default section, add something like
this to the restindex : ::

    section-pages: , page1, page2, page3

Note the extra leading ',' to specify the default section. Alternatively
you can do : ::

    section-pages: section-name, page1, page2, page3

page1 equates to page1.txt, page2 to the file page2.txt, etc.

This should set the order the pages appear in the 'sections' data
structure *and* the sidebar - if it doesn't, then let me know. :-)

All the best,

Fuzzy
Http://www.voidspace.org.uk/python

>Regards
>Wolfgang
>

[Rest2web-develop] About Webgen

[Nicola L. <ni...@te...>]

Hi man,
did you see Webgen? Looks similar to Rest2web, apart from not supporting
ReST, and the Ruby thing: ;-)

http://webgen.rubyforge.org/

-- 
Nicola Larosa - ni...@te...

In the end, guys, you're just as driven by emotions as women.
Trust us... testosterone SO does not enhance your powers of reason.
 -- Kathy Sierra, July 2005

[Rest2web-develop] Re: FYI: print_crumbs doc and function mis-match

[Fuzzyman <fuz...@vo...>]

Hello Soh Kam,

Thanks for your email.

Soh Kam Yung wrote:

>Michael,
>
>I am using rest2web to generate my static off-line website.  Nice piece of work.
>
>  
>
Thank you.

>But I recently updated my rest2web library from your site via
>subversion and I got an error using the print_crumbs() function in my
>template.
>
>I was using calling it in my template as:
>
>print_crumbs(breadcrumbs, '<a href="%s">%s</a>', ">")
>
>This looks correct according to functions.txt.  But when I checked
>functions.py, I found that print_crumbs() now needs an extra
>parameter.
>
>so I change my code to:
>
>print_crumbs(breadcrumbs, "%s", '<a href="%s">%s</a>', ">")
>
>to make things work.
>
>I guess people just call print_crumbs(breadcrumbs), which is why
>nobody noticed the problem.
>
>Looks like functions.txt needs to be updated.
>
>  
>
Yep. See http://www.voidspace.org.uk/python/weblog/index.shtml#e115bugfixes

Admittedly this doesn't actually explain the changes. If you look in the
file ``rest2web/functions.py`` the docstring in there is up to date.

The next step to me releasing 0.4.0 is to update the documentation - I'm
restructuring them quite a lot to make them more accessible. This
includes writing a tutorial.

Anyway - those are just my excuses :-)
I'm sorry you had problems. If you have any questions then feel free to ask.

All the best,

Fuzzyman
http://www.voidspace.org.uk/python


>Regards,
>Kam-Yung
>--
>Soh Kam Yung
>my del.icio.us: (http://del.icio.us/SohKamYung)
>
>  
>

[Rest2web-develop] At Last....

[<mi...@pc...>]

{emo;paper} I've finally managed to spend some time on rest2web__ - and productive time it was too.

I've just checked in the changes to SVN__. Since the last release the following changes have now been made. They're not yet documented because I'm refactoring the documentation substantially.

The changes *include* :

.. contents::

file keyword
------------

You can now specify files to be copied from the source directory to your build directory (the ``file`` keyword in your restindex, which can be used multiple times). Paths are relative to the source file and will always be copied into the same directory as the *target* file.

section-pages
-------------

You can now specify the order that pages appear in the sections and the ``indextree`` data structure. This is the ``section-pages`` keyword. 

It takes a comma separated list as the argument. The first one must be the section followed by a list of pages. You use the filename (minus the '.txt') to specify a page. You don't have to list all the pages - but including a page that doesn't exist will raise an error.

To specify the default section do : ::

    section-pages: ,page1, page2, page3

tags
----

There is a new tags keyword - which takes a comma separated list. Currently this is just put into the namespace. I'm using it for the ``meta keywords`` in my template - but will eventually build a plugin that creates tag clouds for pages.

bugfixes
--------

Over the weekend I found and squashed four bugs. All of these were discovered in the process of making the updates. They were all bugs in obscure places - but nasty enough if they ever bit you. Note that this means that the arguments taken by the ``print_crumbs`` function has changed (it still has sensible defaults though).

* Fixed bug where some restindex options from one section could leak into another.
* Fixed bug where having ``include: No`` for an index page would cause a crash.
* Fixed bug where subsections with a different ``file-extension`` were broken.
* Bugfix (and change) to the ``print_crumbs`` function. It now takes an 'item' value - this means the last item is also a list item.


__prune__
---------

Create a file called ``__prune__`` in a directory and it won't be scanned or included. This messes up auto-built indexes of course, but can be used to stop **rest2web** rebuilding certain parts of your site.


py2exe
------

Hmm.. I didn't actually do much here, but amidst all the changes (including moving to py2exe 0.6.3) - **rest2web** now builds and works using py2exe. The appropriate ``py2exe-setup.py`` is in SVN.



__ /python/rest2web
__ https://svn.rest2web.python-hosting.com