fil / seenthis-python Goto Github PK

This module, currently in a preliminar stage, allows to make requests
to the short-blogging service SeenThis <http://seenthis.net/> from
Python.

Copyright (c) 2011 by Stephane Bortzmeyer
free software, see LICENSE file for details

*** Install ***

1) Short method

# python setup.py install

2) Long method, if the above does not work or if you want to know more

This module uses "distribute", which should be compatible with
"setuptools". If it is not present, it is automatically
downloaded. Same thing for the required modules, which are searched on
PyPi and installed. If you prefer to use local versions, be sure to
install them before running setup.py. Given the awful state of Python
packaging tools (see "Python packaging" by Tarek Ziade in
"Architecture of Open Source Software", Greg Wilson and Amy Brown
<http://www.aosabook.org/en/index.html>), you'll probably have to do
many things by hand. This module requires:

* SimpleTAL <http://www.owlfish.com/software/simpleTAL/>
* FeedParser <http://code.google.com/p/feedparser/> At least version 5 because of 
  <http://code.google.com/p/feedparser/issues/detail?id=91>

OS-specific notes:

Debian: install packages "python-setuptools python-simpletal
python-feedparser" before running setup.py and you'll benefit from
Debian packaging for most of the modules.

Gentoo: TODO

*** Usage ***

Examples of use are the scripts seenthis-backup.py (to backup all your
seens as ATOM feeds), seenthis-post.py (to post a message),
seenthis-get-msg.py (to retrieve an ATOM representation of a seen by
its Message-ID) and seenthis-test-url.py (to test if a given URL is
alreday in SeenThis).

All these scripts need a file storing SeenThis authentication
info. The file must be named $HOME/.seenthis/auth and contain two
lines, one for the user name and one for the password.

*** API ***

The SeenThis API is documented (in French only) in
<http://seenthis.net/fran%C3%A7ais/mentions/article/api> but some
functions are documented elsewhere such as
<http://seenthis.net/messages/14646>,
<http://seenthis.net/messages/13772> or
<http://seenthis.net/messages/70484>.

*** Author ***

You can always write me at [email protected]
My account on SeenThis is "bortzmeyer"
<http://seenthis.net/people/st%C3%A9phane-bortzmeyer>

With patches from Valentin Lorentz <https://github.com/ProgVal/seenthis-python>