[python] documentation & TODO list

2011-12-06 Thread Sebastian Spaeth
On Mon, 05 Dec 2011 22:36:06 +, Patrick Totzke wrote:
> These are the things I noticed when going through the code today:
> 1) in filenames.py,  __str__ of Filenames: should the return value be
>'\n'.join(self._files)? alternatively, define __iter__ to make this object
>behave as iterator.

To be honest, I don't remember why the code looks the way it looks, but
it certainly is not right like this. Defining __iter__ sounds like a
correct thing to me, but it could be that there was some reason why I
don't have it...
Feel free to implement a working __iter__ and provide a patch :-).

> 2) in message.py:  tags_to_maildir_flags and maildir_flags_to_tags never 
> return a
>:class:`STATUS` as advertised.

But it has been doing that for, , 1 minute :-)
[master ecf8da3] python: Return a STATUS value in tags_to_flags and 
flags_to_tags

(thanks)

> I would like to see up-to-date API docs online, even if only the
> version string changed.
> Sebastian suggested using readthedocs.org for building and hosting APIdocs.

I currently manually upload a generated API doc to the
packages.python.org website. I kind of like that address because it
sounds official ;-), but it is manual work. I am currently not looking
into expending the efforts I have to do on python notmuch. So setting

> I tested this recently for alot and it looks quite promising.
> A simple http get and their build-host checks out the new sources from git 
> and builds
> them. This could be easily integrated into notmuch the release process.
> Comments on this?

I think that it would be cool to have that automatically been done on
notmuchmail.org. But given that it takes some work to set that up and
readthedocs.org is already there, I am all for using that for now.

> Lastly, does anyone have an opinion on how to share a TODO list/issue tracker
> for the bindings? I'm OK with github, we could move all this to the list
> and use David's nmbug..

Ohh, there is already notmuch::python in nmbug :-)

Sebastian
-- next part --
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 197 bytes
Desc: not available
URL: 



Re: [python] documentation TODO list

2011-12-06 Thread Sebastian Spaeth
On Mon, 05 Dec 2011 22:36:06 +, Patrick Totzke wrote:
 These are the things I noticed when going through the code today:
 1) in filenames.py,  __str__ of Filenames: should the return value be
'\n'.join(self._files)? alternatively, define __iter__ to make this object
behave as iterator.

To be honest, I don't remember why the code looks the way it looks, but
it certainly is not right like this. Defining __iter__ sounds like a
correct thing to me, but it could be that there was some reason why I
don't have it...
Feel free to implement a working __iter__ and provide a patch :-).

 2) in message.py:  tags_to_maildir_flags and maildir_flags_to_tags never 
 return a
:class:`STATUS` as advertised.

But it has been doing that for, , 1 minute :-)
[master ecf8da3] python: Return a STATUS value in tags_to_flags and 
flags_to_tags

(thanks)

 I would like to see up-to-date API docs online, even if only the
 version string changed.
 Sebastian suggested using readthedocs.org for building and hosting APIdocs.

I currently manually upload a generated API doc to the
packages.python.org website. I kind of like that address because it
sounds official ;-), but it is manual work. I am currently not looking
into expending the efforts I have to do on python notmuch. So setting

 I tested this recently for alot and it looks quite promising.
 A simple http get and their build-host checks out the new sources from git 
 and builds
 them. This could be easily integrated into notmuch the release process.
 Comments on this?

I think that it would be cool to have that automatically been done on
notmuchmail.org. But given that it takes some work to set that up and
readthedocs.org is already there, I am all for using that for now.
 
 Lastly, does anyone have an opinion on how to share a TODO list/issue tracker
 for the bindings? I'm OK with github, we could move all this to the list
 and use David's nmbug..

Ohh, there is already notmuch::python in nmbug :-)

Sebastian


pgpvmNwxDccJY.pgp
Description: PGP signature
___
notmuch mailing list
notmuch@notmuchmail.org
http://notmuchmail.org/mailman/listinfo/notmuch


[python] documentation & TODO list

2011-12-05 Thread Patrick Totzke

Hi!

This is mainly directed towards Sebastian, but a broader audience can't hurt.

These are the things I noticed when going through the code today:
1) in filenames.py,  __str__ of Filenames: should the return value be
   '\n'.join(self._files)? alternatively, define __iter__ to make this object
   behave as iterator.
2) in message.py:  tags_to_maildir_flags and maildir_flags_to_tags never return 
a
   :class:`STATUS` as advertised.
3) unicode stuff alredy patched..

I would like to see up-to-date API docs online, even if only the
version string changed.
Sebastian suggested using readthedocs.org for building and hosting APIdocs.
I tested this recently for alot and it looks quite promising.
A simple http get and their build-host checks out the new sources from git and 
builds
them. This could be easily integrated into notmuch the release process.
Comments on this?

Lastly, does anyone have an opinion on how to share a TODO list/issue tracker
for the bindings? I'm OK with github, we could move all this to the list
and use David's nmbug..

Cheers,
/Patrick



[python] documentation TODO list

2011-12-05 Thread Patrick Totzke

Hi!

This is mainly directed towards Sebastian, but a broader audience can't hurt.

These are the things I noticed when going through the code today:
1) in filenames.py,  __str__ of Filenames: should the return value be
   '\n'.join(self._files)? alternatively, define __iter__ to make this object
   behave as iterator.
2) in message.py:  tags_to_maildir_flags and maildir_flags_to_tags never return 
a
   :class:`STATUS` as advertised.
3) unicode stuff alredy patched..

I would like to see up-to-date API docs online, even if only the
version string changed.
Sebastian suggested using readthedocs.org for building and hosting APIdocs.
I tested this recently for alot and it looks quite promising.
A simple http get and their build-host checks out the new sources from git and 
builds
them. This could be easily integrated into notmuch the release process.
Comments on this?

Lastly, does anyone have an opinion on how to share a TODO list/issue tracker
for the bindings? I'm OK with github, we could move all this to the list
and use David's nmbug..

Cheers,
/Patrick

___
notmuch mailing list
notmuch@notmuchmail.org
http://notmuchmail.org/mailman/listinfo/notmuch


python documentation

2011-04-19 Thread Sebastian Spaeth
On Mon, 18 Apr 2011 17:03:01 +0200, Florian Friesdorf  
wrote:
> Is it sane to have python bindings that need updates or would a plain
> wrapper of the notmuch script (that maybe needs less updates) be better?
> I don't want to imply that this can be answered with yes/no, but more to
> get a comparison of the two approaches.

Invoking notmuch the script and piping the results? I wouldn't call that
python bindings anymore then. Also it is bound to be much more expensive
than directly interfacing libnotmuch.so.

> Na?vely, I imagine there is a header file and the generation of the
> python bindings happens rather automagic.

I wish it would be that easy. :-)

Sebastian
-- next part --
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 197 bytes
Desc: not available
URL: 



python documentation

2011-04-19 Thread Aaron Williamson
On 04/19/2011 04:01 PM, Sebastian Spaeth wrote:
> On Mon, 18 Apr 2011 17:03:01 +0200, Florian Friesdorf  
> wrote:
>> Is it sane to have python bindings that need updates or would a plain
>> wrapper of the notmuch script (that maybe needs less updates) be better?
>> I don't want to imply that this can be answered with yes/no, but more to
>> get a comparison of the two approaches.
> 
> Invoking notmuch the script and piping the results? I wouldn't call that
> python bindings anymore then. Also it is bound to be much more expensive
> than directly interfacing libnotmuch.so.
> 
>> Na?vely, I imagine there is a header file and the generation of the
>> python bindings happens rather automagic.
> 
> I wish it would be that easy. :-)

I've never actually used it, so I may be way off base, but would it be possible
to use SWIG (http://www.swig.org/) to automatically generate bindings when the C
library is updated, or at least provide a decent starting point?

Aaron


Re: python documentation

2011-04-19 Thread Sebastian Spaeth
On Mon, 18 Apr 2011 17:03:01 +0200, Florian Friesdorf f...@chaoflow.net wrote:
 Is it sane to have python bindings that need updates or would a plain
 wrapper of the notmuch script (that maybe needs less updates) be better?
 I don't want to imply that this can be answered with yes/no, but more to
 get a comparison of the two approaches.

Invoking notmuch the script and piping the results? I wouldn't call that
python bindings anymore then. Also it is bound to be much more expensive
than directly interfacing libnotmuch.so.

 Naïvely, I imagine there is a header file and the generation of the
 python bindings happens rather automagic.

I wish it would be that easy. :-)

Sebastian


pgpgbZjHlGYh1.pgp
Description: PGP signature
___
notmuch mailing list
notmuch@notmuchmail.org
http://notmuchmail.org/mailman/listinfo/notmuch


Re: python documentation

2011-04-19 Thread Aaron Williamson
On 04/19/2011 04:01 PM, Sebastian Spaeth wrote:
 On Mon, 18 Apr 2011 17:03:01 +0200, Florian Friesdorf f...@chaoflow.net 
 wrote:
 Is it sane to have python bindings that need updates or would a plain
 wrapper of the notmuch script (that maybe needs less updates) be better?
 I don't want to imply that this can be answered with yes/no, but more to
 get a comparison of the two approaches.
 
 Invoking notmuch the script and piping the results? I wouldn't call that
 python bindings anymore then. Also it is bound to be much more expensive
 than directly interfacing libnotmuch.so.
 
 Naïvely, I imagine there is a header file and the generation of the
 python bindings happens rather automagic.
 
 I wish it would be that easy. :-)

I've never actually used it, so I may be way off base, but would it be possible
to use SWIG (http://www.swig.org/) to automatically generate bindings when the C
library is updated, or at least provide a decent starting point?

Aaron
___
notmuch mailing list
notmuch@notmuchmail.org
http://notmuchmail.org/mailman/listinfo/notmuch


python documentation

2011-04-18 Thread Florian Friesdorf
On Mon, 18 Apr 2011 15:57:26 +0200, Sebastian Spaeth  
wrote:
> On Mon, 18 Apr 2011 14:32:16 +0200, Florian Friesdorf  
> wrote:
> > I think it is confusing that it has a different versioning than notmuch
> > itself and that it would be more intuitive if the current bindings on
> > pypi [1] would have the same version as the current stable release of
> > notmuch.
> 
> But that would require that the python bindings are actually updated to
> the current API of notmuch :-). Because they currently are not. E.g. the
> get_filename/get_filenames addition is still not included.

Is it sane to have python bindings that need updates or would a plain
wrapper of the notmuch script (that maybe needs less updates) be better?
I don't want to imply that this can be answered with yes/no, but more to
get a comparison of the two approaches.

Na?vely, I imagine there is a header file and the generation of the
python bindings happens rather automagic.

> > If they would also work with older releases of notmuch, that
> > could still be indicated, as it is done now.
> 
> As far as for testing current implementations with older notmuch
> libraries, I welcome people to contribute patches to the documentation
> because I certainly will not test all combinations :-).
> 
> To be honest, I don't even use the python bindings anymore, not that
> notmuch proper is able to give me all I need (especially file names).

Point taken, I don't use them yet, I might in the future.

-- 
Florian Friesdorf 
  GPG FPR: 7A13 5EEE 1421 9FC2 108D  BAAF 38F8 99A3 0C45 F083
Jabber/XMPP: flo at chaoflow.net
IRC: chaoflow on freenode,ircnet,blafasel,OFTC
-- next part --
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 835 bytes
Desc: not available
URL: 



python documentation

2011-04-18 Thread Sebastian Spaeth
On Mon, 18 Apr 2011 14:32:16 +0200, Florian Friesdorf  
wrote:
> On Tue, 15 Mar 2011 16:16:15 +0100, Sebastian Spaeth  SSpaeth.de> wrote:
> > > http://packages.python.org/notmuch/

> I updated http://notmuchmail.org/howto/ to point to notmuch instead of
> cnotmuch, but I cannot tell whether the example there is still
> up-to-date.

Yes, the examples there are current and still working.

> I think it is confusing that it has a different versioning than notmuch
> itself and that it would be more intuitive if the current bindings on
> pypi [1] would have the same version as the current stable release of
> notmuch.

But that would require that the python bindings are actually updated to
the current API of notmuch :-). Because they currently are not. E.g. the
get_filename/get_filenames addition is still not included.

> If they would also work with older releases of notmuch, that
> could still be indicated, as it is done now.

As far as for testing current implementations with older notmuch
libraries, I welcome people to contribute patches to the documentation
because I certainly will not test all combinations :-).

To be honest, I don't even use the python bindings anymore, not that
notmuch proper is able to give me all I need (especially file names).

Sebastian
-- next part --
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 197 bytes
Desc: not available
URL: 



python documentation

2011-04-18 Thread Florian Friesdorf
On Tue, 15 Mar 2011 16:16:15 +0100, Sebastian Spaeth  
wrote:
> On Mon, 14 Mar 2011 23:26:29 -0700, Jameson Rollins wrote:
> > I just discovered this:
> > 
> > http://packages.python.org/notmuch/
> > 
> > I don't know who did this, but THANK YOU!!  I want to buy you a beer.
> 
> I prefer the stronger type of beer. But I'll even take Budweiser :-).
> 
> Please ship in August to San Antonio, Texas when I'll be there for a
> conference ;).
> 
> Seriously, you are welcome. I am lagging a bit behind changes in notmuch
> (the get_filenames iterator comes to my mind). But I do like to deliver
> my stuff with complete docs...

Highly appreciated!

I updated http://notmuchmail.org/howto/ to point to notmuch instead of
cnotmuch, but I cannot tell whether the example there is still
up-to-date.

I think it is confusing that it has a different versioning than notmuch
itself and that it would be more intuitive if the current bindings on
pypi [1] would have the same version as the current stable release of
notmuch. If they would also work with older releases of notmuch, that
could still be indicated, as it is done now.

[1] http://pypi.python.org/pypi/notmuch

-- 
Florian Friesdorf 
  GPG FPR: 7A13 5EEE 1421 9FC2 108D  BAAF 38F8 99A3 0C45 F083
Jabber/XMPP: flo at chaoflow.net
IRC: chaoflow on freenode,ircnet,blafasel,OFTC
-- next part --
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 835 bytes
Desc: not available
URL: 



Re: python documentation

2011-04-18 Thread Florian Friesdorf
On Tue, 15 Mar 2011 16:16:15 +0100, Sebastian Spaeth sebast...@sspaeth.de 
wrote:
 On Mon, 14 Mar 2011 23:26:29 -0700, Jameson Rollins wrote:
  I just discovered this:
  
  http://packages.python.org/notmuch/
  
  I don't know who did this, but THANK YOU!!  I want to buy you a beer.
 
 I prefer the stronger type of beer. But I'll even take Budweiser :-).
 
 Please ship in August to San Antonio, Texas when I'll be there for a
 conference ;).
 
 Seriously, you are welcome. I am lagging a bit behind changes in notmuch
 (the get_filenames iterator comes to my mind). But I do like to deliver
 my stuff with complete docs...

Highly appreciated!

I updated http://notmuchmail.org/howto/ to point to notmuch instead of
cnotmuch, but I cannot tell whether the example there is still
up-to-date.

I think it is confusing that it has a different versioning than notmuch
itself and that it would be more intuitive if the current bindings on
pypi [1] would have the same version as the current stable release of
notmuch. If they would also work with older releases of notmuch, that
could still be indicated, as it is done now.

[1] http://pypi.python.org/pypi/notmuch

-- 
Florian Friesdorf f...@chaoflow.net
  GPG FPR: 7A13 5EEE 1421 9FC2 108D  BAAF 38F8 99A3 0C45 F083
Jabber/XMPP: f...@chaoflow.net
IRC: chaoflow on freenode,ircnet,blafasel,OFTC


pgpx2p9PppmaD.pgp
Description: PGP signature
___
notmuch mailing list
notmuch@notmuchmail.org
http://notmuchmail.org/mailman/listinfo/notmuch


Re: python documentation

2011-04-18 Thread Sebastian Spaeth
On Mon, 18 Apr 2011 14:32:16 +0200, Florian Friesdorf f...@chaoflow.net wrote:
 On Tue, 15 Mar 2011 16:16:15 +0100, Sebastian Spaeth sebast...@sspaeth.de 
 wrote:
   http://packages.python.org/notmuch/

 I updated http://notmuchmail.org/howto/ to point to notmuch instead of
 cnotmuch, but I cannot tell whether the example there is still
 up-to-date.

Yes, the examples there are current and still working.
 
 I think it is confusing that it has a different versioning than notmuch
 itself and that it would be more intuitive if the current bindings on
 pypi [1] would have the same version as the current stable release of
 notmuch.

But that would require that the python bindings are actually updated to
the current API of notmuch :-). Because they currently are not. E.g. the
get_filename/get_filenames addition is still not included.

 If they would also work with older releases of notmuch, that
 could still be indicated, as it is done now.

As far as for testing current implementations with older notmuch
libraries, I welcome people to contribute patches to the documentation
because I certainly will not test all combinations :-).

To be honest, I don't even use the python bindings anymore, not that
notmuch proper is able to give me all I need (especially file names).

Sebastian


pgp09ZMmolGN1.pgp
Description: PGP signature
___
notmuch mailing list
notmuch@notmuchmail.org
http://notmuchmail.org/mailman/listinfo/notmuch


python documentation

2011-03-16 Thread Sebastian Spaeth
On Tue, 15 Mar 2011 15:01:15 -0400, James Vasile  
wrote:
> Yep, just a completed TODO.  Patch below.

Fixed and pushed. Thanks.

Sebastian
-- next part --
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 197 bytes
Desc: not available
URL: 



Re: python documentation

2011-03-16 Thread Sebastian Spaeth
On Tue, 15 Mar 2011 15:01:15 -0400, James Vasile ja...@hackervisions.org 
wrote:
 Yep, just a completed TODO.  Patch below.

Fixed and pushed. Thanks.

Sebastian


pgpNYkRfIXRj1.pgp
Description: PGP signature
___
notmuch mailing list
notmuch@notmuchmail.org
http://notmuchmail.org/mailman/listinfo/notmuch


python documentation

2011-03-15 Thread Sebastian Spaeth
On Mon, 14 Mar 2011 23:26:29 -0700, Jameson Rollins wrote:
> I just discovered this:
> 
> http://packages.python.org/notmuch/
> 
> I don't know who did this, but THANK YOU!!  I want to buy you a beer.

I prefer the stronger type of beer. But I'll even take Budweiser :-).

Please ship in August to San Antonio, Texas when I'll be there for a
conference ;).

Seriously, you are welcome. I am lagging a bit behind changes in notmuch
(the get_filenames iterator comes to my mind). But I do like to deliver
my stuff with complete docs...

Sebastian
-- next part --
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 197 bytes
Desc: not available
URL: 



python documentation

2011-03-15 Thread James Vasile
On Tue, 15 Mar 2011 11:33:19 -0700, Jameson Rollins  wrote:
> On Tue, 15 Mar 2011 14:22:55 -0400, James Vasile  
> wrote:
> > notmuch dump includes '# TODO: implement "dump "' but it
> > appears to work already.  What's missing?
> 
> Hey, James.  Is this related to the python documentation somehow?  If
> so, I'm not sure how.
> 
> If you're just referencing a completed TODO, you could definitely submit
> a patch to remove it from the TODO.
> 

Yep, just a completed TODO.  Patch below.

diff --git a/bindings/python/notmuch.py b/bindings/python/notmuch.py
index 8572612..8d11859 100755
--- a/bindings/python/notmuch.py
+++ b/bindings/python/notmuch.py
@@ -486,7 +486,6 @@ def main():
 print "\n".join([t for t in msgs.collect_tags()])
 #-
 elif sys.argv[1] == 'dump':
-# TODO: implement "dump "
 if len(sys.argv) == 2:
 f = sys.stdout
 else:


python documentation

2011-03-15 Thread James Vasile
notmuch dump includes '# TODO: implement "dump "' but it
appears to work already.  What's missing?

Thanks,
James


python documentation

2011-03-15 Thread Jameson Rollins
On Tue, 15 Mar 2011 14:22:55 -0400, James Vasile  
wrote:
> notmuch dump includes '# TODO: implement "dump "' but it
> appears to work already.  What's missing?

Hey, James.  Is this related to the python documentation somehow?  If
so, I'm not sure how.

If you're just referencing a completed TODO, you could definitely submit
a patch to remove it from the TODO.

jamie.
-- next part --
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 835 bytes
Desc: not available
URL: 
<http://notmuchmail.org/pipermail/notmuch/attachments/20110315/cce0ccd6/attachment-0001.pgp>


python documentation

2011-03-15 Thread Jameson Rollins
I just discovered this:

http://packages.python.org/notmuch/

I don't know who did this, but THANK YOU!!  I want to buy you a beer.

jamie.
-- next part --
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 835 bytes
Desc: not available
URL: 



Re: python documentation

2011-03-15 Thread Sebastian Spaeth
On Mon, 14 Mar 2011 23:26:29 -0700, Jameson Rollins wrote:
 I just discovered this:
 
 http://packages.python.org/notmuch/
 
 I don't know who did this, but THANK YOU!!  I want to buy you a beer.

I prefer the stronger type of beer. But I'll even take Budweiser :-).

Please ship in August to San Antonio, Texas when I'll be there for a
conference ;).

Seriously, you are welcome. I am lagging a bit behind changes in notmuch
(the get_filenames iterator comes to my mind). But I do like to deliver
my stuff with complete docs...

Sebastian


pgpMxgHC3VAGZ.pgp
Description: PGP signature
___
notmuch mailing list
notmuch@notmuchmail.org
http://notmuchmail.org/mailman/listinfo/notmuch


Re: python documentation

2011-03-15 Thread James Vasile
notmuch dump includes '# TODO: implement dump filename' but it
appears to work already.  What's missing?

Thanks,
James
___
notmuch mailing list
notmuch@notmuchmail.org
http://notmuchmail.org/mailman/listinfo/notmuch


Re: python documentation

2011-03-15 Thread Jameson Rollins
On Tue, 15 Mar 2011 14:22:55 -0400, James Vasile ja...@hackervisions.org 
wrote:
 notmuch dump includes '# TODO: implement dump filename' but it
 appears to work already.  What's missing?

Hey, James.  Is this related to the python documentation somehow?  If
so, I'm not sure how.

If you're just referencing a completed TODO, you could definitely submit
a patch to remove it from the TODO.

jamie.


pgpQ2PG6wG8NB.pgp
Description: PGP signature
___
notmuch mailing list
notmuch@notmuchmail.org
http://notmuchmail.org/mailman/listinfo/notmuch


Re: python documentation

2011-03-15 Thread James Vasile
On Tue, 15 Mar 2011 11:33:19 -0700, Jameson Rollins 
jroll...@finestructure.net wrote:
 On Tue, 15 Mar 2011 14:22:55 -0400, James Vasile ja...@hackervisions.org 
 wrote:
  notmuch dump includes '# TODO: implement dump filename' but it
  appears to work already.  What's missing?
 
 Hey, James.  Is this related to the python documentation somehow?  If
 so, I'm not sure how.
 
 If you're just referencing a completed TODO, you could definitely submit
 a patch to remove it from the TODO.
 

Yep, just a completed TODO.  Patch below.

diff --git a/bindings/python/notmuch.py b/bindings/python/notmuch.py
index 8572612..8d11859 100755
--- a/bindings/python/notmuch.py
+++ b/bindings/python/notmuch.py
@@ -486,7 +486,6 @@ def main():
 print \n.join([t for t in msgs.collect_tags()])
 #-
 elif sys.argv[1] == 'dump':
-# TODO: implement dump filename
 if len(sys.argv) == 2:
 f = sys.stdout
 else:
___
notmuch mailing list
notmuch@notmuchmail.org
http://notmuchmail.org/mailman/listinfo/notmuch