1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
|
"""Library to access del.icio.us data via Python.
:examples:
Using the API class directly:
>>> a = pydelicious.apiNew('user', 'passwd')
>>> # or:
>>> a = DeliciousAPI('user', 'passwd')
>>> a.tags_get() # Same as:
>>> a.request('tags/get', )
Or by calling one of the methods on the module:
- add(user, passwd, url, description, tags = "", extended = "", dt = "", replace="no")
- get(user, passwd, tag="", dt="", count = 0)
- get_all(user, passwd, tag = "")
- delete(user, passwd, url)
- rename_tag(user, passwd, oldtag, newtag)
- get_tags(user, passwd)
>>> a = apiNew(user, passwd)
>>> a.posts_add(url="http://my.com/", desciption="my.com", extended="the url is my.moc", tags="my com")
True
>>> len(a.posts_all())
1
>>> get_all(user, passwd)
1
This are short functions for getrss calls.
>>> rss_
def get_userposts(user):
def get_tagposts(tag):
def get_urlposts(url):
def get_popular(tag = ""):
>>> json_posts()
>>> json_tags()
>>> json_network()
>>> json_fans()
:License: pydelicious is released under the BSD license. See 'license.txt'
for more informations.
:todo, bvb:
- Rewriting comments to english. More documentation, examples.
- Added JSON-like return values for XML data (del.icio.us also serves some JSON...)
- better error/exception classes and handling, work in progress.
:todo:
- Source code SHOULD BE ASCII!
- More tests.
- handling different encodings, what, how?
>>> pydelicious.getrss(tag="t[a]g")
url: http://del.icio.us/rss/tag/t[a]g
- Parse datetimes in XML.
- Test RSS functionality? HTML scraping doesn't work yet?
- API functions need required argument checks.
- interesting functionality in other libraries (ruby, java, perl, etc)?
- what is pydelicious used for?
- license, readme docs via setup.py verdelen?
- automatic releas build
:done:
* Refactored the API class, much cleaner now and functions dlcs_api_request, dlcs_parse_xml are available for who wants them.
"""
import sys
import os
import time
import datetime
import md5, httplib
import urllib, urllib2, time
from StringIO import StringIO
try:
from elementtree.ElementTree import parse as parse_xml
except ImportError:
from xml.etree.ElementTree import parse as parse_xml
import feedparser
### Static config
__version__ = '0.5.0'
__author__ = 'Frank Timmermann <regenkind_at_gmx_dot_de>' # GP: does not respond to emails
__contributors__ = [
'Greg Pinero',
'Berend van Berkum <berend+pydelicious@dotmpe.com>']
__url__ = 'http://code.google.com/p/pydelicious/'
__author_email__ = ""
# Old URL: 'http://deliciouspython.python-hosting.com/'
__description__ = '''pydelicious.py allows you to access the web service of del.icio.us via it's API through python.'''
__long_description__ = '''the goal is to design an easy to use and fully functional python interface to del.icio.us. '''
DLCS_OK_MESSAGES = ('done', 'ok') # Known text values of positive del.icio.us <result> answers
DLCS_WAIT_TIME = 4
DLCS_REQUEST_TIMEOUT = 444 # Seconds before socket triggers timeout
#DLCS_API_REALM = 'del.icio.us API'
DLCS_API_HOST = 'https://api.del.icio.us'
DLCS_API_PATH = 'v1'
DLCS_API = "%s/%s" % (DLCS_API_HOST, DLCS_API_PATH)
DLCS_RSS = 'http://del.icio.us/rss/'
ISO_8601_DATETIME = '%Y-%m-%dT%H:%M:%SZ'
USER_AGENT = 'pydelicious.py/%s %s' % (__version__, __url__)
DEBUG = 0
if 'DLCS_DEBUG' in os.environ:
DEBUG = int(os.environ['DLCS_DEBUG'])
# Taken from FeedParser.py
# timeoutsocket allows feedparser to time out rather than hang forever on ultra-slow servers.
# Python 2.3 now has this functionality available in the standard socket library, so under
# 2.3 you don't need to install anything. But you probably should anyway, because the socket
# module is buggy and timeoutsocket is better.
try:
import timeoutsocket # http://www.timo-tasi.org/python/timeoutsocket.py
timeoutsocket.setDefaultSocketTimeout(DLCS_REQUEST_TIMEOUT)
except ImportError:
import socket
if hasattr(socket, 'setdefaulttimeout'): socket.setdefaulttimeout(DLCS_REQUEST_TIMEOUT)
if DEBUG: print >>sys.stderr, "Set socket timeout to %s seconds" % DLCS_REQUEST_TIMEOUT
### Utility classes
class _Waiter:
"""Waiter makes sure a certain amount of time passes between
successive calls of `Waiter()`.
Some attributes:
:last: time of last call
:wait: the minimum time needed between calls
:waited: the number of calls throttled
pydelicious.Waiter is an instance created when the module is loaded.
"""
def __init__(self, wait):
self.wait = wait
self.waited = 0
self.lastcall = 0;
def __call__(self):
tt = time.time()
wait = self.wait
timeago = tt - self.lastcall
if timeago < wait:
wait = wait - timeago
if DEBUG>0: print >>sys.stderr, "Waiting %s seconds." % wait
time.sleep(wait)
self.waited += 1
self.lastcall = tt + wait
else:
self.lastcall = tt
Waiter = _Waiter(DLCS_WAIT_TIME)
class PyDeliciousException(Exception):
'''Std. pydelicious error'''
pass
class DeliciousError(Exception):
"""Raised when the server responds with a negative answer"""
class DefaultErrorHandler(urllib2.HTTPDefaultErrorHandler):
'''xxx, bvb: Where is this used? should it be registered somewhere with urllib2?
Handles HTTP Error, currently only 503.
'''
def http_error_503(self, req, fp, code, msg, headers):
raise urllib2.HTTPError(req, code, throttled_message, headers, fp)
class post(dict):
"""Post object, contains href, description, hash, dt, tags,
extended, user, count(, shared).
xxx, bvb: Not used in DeliciousAPI
"""
def __init__(self, href="", description="", hash="", time="", tag="", extended="", user="", count="",
tags="", url="", dt=""): # tags or tag?
self["href"] = href
if url != "": self["href"] = url
self["description"] = description
self["hash"] = hash
self["dt"] = dt
if time != "": self["dt"] = time
self["tags"] = tags
if tag != "": self["tags"] = tag # tag or tags? # !! tags
self["extended"] = extended
self["user"] = user
self["count"] = count
def __getattr__(self, name):
try: return self[name]
except: object.__getattribute__(self, name)
class posts(list):
def __init__(self, *args):
for i in args: self.append(i)
def __getattr__(self, attr):
try: return [p[attr] for p in self]
except: object.__getattribute__(self, attr)
### Utility functions
def str2uni(s):
# type(in) str or unicode
# type(out) unicode
return ("".join([unichr(ord(i)) for i in s]))
def str2utf8(s):
# type(in) str or unicode
# type(out) str
return ("".join([unichr(ord(i)).encode("utf-8") for i in s]))
def str2quote(s):
return urllib.quote_plus("".join([unichr(ord(i)).encode("utf-8") for i in s]))
def dict0(d):
# Trims empty dict entries
# {'a':'a', 'b':'', 'c': 'c'} => {'a': 'a', 'c': 'c'}
dd = dict()
for i in d:
if d[i] != "": dd[i] = d[i]
return dd
def delicious_datetime(str):
"""Parse a ISO 8601 formatted string to a Python datetime ...
"""
return datetime.datetime(*time.strptime(str, ISO_8601_DATETIME)[0:6])
def http_request(url, user_agent=USER_AGENT, retry=4):
"""Retrieve the contents referenced by the URL using urllib2.
Retries up to four times (default) on exceptions.
"""
request = urllib2.Request(url, headers={'User-Agent':user_agent})
# Remember last error
e = None
# Repeat request on time-out errors
tries = retry;
while tries:
try:
return urllib2.urlopen(request)
except urllib2.HTTPError, e: # protocol errors,
raise PyDeliciousException, "%s" % e
except urllib2.URLError, e:
# xxx: Ugly check for time-out errors
#if len(e)>0 and 'timed out' in arg[0]:
print >> sys.stderr, "%s, %s tries left." % (e, tries)
Waiter()
tries = tries - 1
#else:
# tries = None
# Give up
raise PyDeliciousException, \
"Unable to retrieve data at '%s', %s" % (url, e)
def http_auth_request(url, host, user, passwd, user_agent=USER_AGENT):
"""Call an HTTP server with authorization credentials using urllib2.
"""
if DEBUG: httplib.HTTPConnection.debuglevel = 1
# Hook up handler/opener to urllib2
password_manager = urllib2.HTTPPasswordMgrWithDefaultRealm()
password_manager.add_password(None, host, user, passwd)
auth_handler = urllib2.HTTPBasicAuthHandler(password_manager)
opener = urllib2.build_opener(auth_handler)
urllib2.install_opener(opener)
return http_request(url, user_agent)
def dlcs_api_request(path, params='', user='', passwd='', throttle=True):
"""Retrieve/query a path within the del.icio.us API.
This implements a minimum interval between calls to avoid
throttling. [#]_ Use param 'throttle' to turn this behaviour off.
todo: back off on 503's (HTTPError, URLError? testing
Returned XML does not always correspond with given del.icio.us examples
[#]_.
.. [#] http://del.icio.us/help/api/
"""
if throttle:
Waiter()
if params:
# params come as a dict, strip empty entries and urlencode
url = "%s/%s?%s" % (DLCS_API, path, urllib.urlencode(dict0(params)))
else:
url = "%s/%s" % (DLCS_API, path)
if DEBUG: print >>sys.stderr, "dlcs_api_request: %s" % url
try:
return http_auth_request(url, DLCS_API_HOST, user, passwd, USER_AGENT)
# bvb: Is this ever raised? When?
except DefaultErrorHandler, e:
print >>sys.stderr, "%s" % e
def dlcs_parse_xml(data, split_tags=False):
"""Parse any del.icio.us XML document and return Python data structure.
Recognizes all XML document formats as returned by the version 1 API and
translates to a JSON-like data structure (dicts 'n lists).
Returned instance is always a dictionary. Examples::
{'posts': [{'url':'...','hash':'...',},],}
{'tags':['tag1', 'tag2',]}
{'dates': [{'count':'...','date':'...'},], 'tag':'', 'user':'...'}
{'result':(True, "done")}
# etcetera.
"""
if DEBUG>3: print >>sys.stderr, "dlcs_parse_xml: parsing from ", data
if not hasattr(data, 'read'):
data = StringIO(data)
doc = parse_xml(data)
root = doc.getroot()
fmt = root.tag
# Split up into three cases: Data, Result or Update
if fmt in ('tags', 'posts', 'dates', 'bundles'):
# Data: expect a list of data elements, 'resources'.
# Use `fmt` (without last 's') to find data elements, elements
# don't have contents, attributes contain all the data we need:
# append to list
elist = [el.attrib for el in doc.findall(fmt[:-1])]
# Return list in dict, use tagname of rootnode as keyname.
data = {fmt: elist}
# Root element might have attributes too, append dict.
data.update(root.attrib)
return data
elif fmt == 'result':
# Result: answer to operations
if root.attrib.has_key('code'):
msg = root.attrib['code']
else:
msg = root.text
# Return {'result':(True, msg)} for /known/ O.K. messages,
# use (False, msg) otherwise
v = msg in DLCS_OK_MESSAGES
return {fmt: (v, msg)}
elif fmt == 'update':
# Update: "time"
#return {fmt: root.attrib}
return {fmt: {'time':time.strptime(root.attrib['time'], ISO_8601_DATETIME)}}
else:
raise PyDeliciousException, "Unknown XML document format '%s'" % fmt
def dlcs_rss_request(tag = "", popular = 0, user = "", url = ''):
"""Handle a request for RSS
todo: translate from German
rss sollte nun wieder funktionieren, aber diese try, except scheisse ist so nicht schoen
rss wird unterschiedlich zusammengesetzt. ich kann noch keinen einheitlichen zusammenhang
zwischen daten (url, desc, ext, usw) und dem feed erkennen. warum k[o]nnen die das nicht einheitlich machen?
"""
tag = str2quote(tag)
user = str2quote(user)
if url != '':
# http://del.icio.us/rss/url/efbfb246d886393d48065551434dab54
url = DLCS_RSS + '''url/%s'''%md5.new(url).hexdigest()
elif user != '' and tag != '':
url = DLCS_RSS + '''%(user)s/%(tag)s'''%dict(user=user, tag=tag)
elif user != '' and tag == '':
# http://del.icio.us/rss/delpy
url = DLCS_RSS + '''%s'''%user
elif popular == 0 and tag == '':
url = DLCS_RSS
elif popular == 0 and tag != '':
# http://del.icio.us/rss/tag/apple
# http://del.icio.us/rss/tag/web2.0
url = DLCS_RSS + "tag/%s"%tag
elif popular == 1 and tag == '':
url = DLCS_RSS + '''popular/'''
elif popular == 1 and tag != '':
url = DLCS_RSS + '''popular/%s'''%tag
rss = http_request(url).read()
rss = feedparser.parse(rss)
# print rss
# for e in rss.entries: print e;print
l = posts()
for e in rss.entries:
if e.has_key("links") and e["links"]!=[] and e["links"][0].has_key("href"):
url = e["links"][0]["href"]
elif e.has_key("link"):
url = e["link"]
elif e.has_key("id"):
url = e["id"]
else:
url = ""
if e.has_key("title"):
description = e['title']
elif e.has_key("title_detail") and e["title_detail"].has_key("title"):
description = e["title_detail"]['value']
else:
description = ''
try: tags = e['categories'][0][1]
except:
try: tags = e["category"]
except: tags = ""
if e.has_key("modified"):
dt = e['modified']
else:
dt = ""
if e.has_key("summary"):
extended = e['summary']
elif e.has_key("summary_detail"):
e['summary_detail']["value"]
else:
extended = ""
if e.has_key("author"):
user = e['author']
else:
user = ""
# time = dt ist weist auf ein problem hin
# die benennung der variablen ist nicht einheitlich
# api senden und
# xml bekommen sind zwei verschiedene schuhe :(
l.append(post(url = url, description = description, tags = tags, dt = dt, extended = extended, user = user))
return l
### Main module class
class DeliciousAPI:
"""Class providing main interace to del.icio.us API.
Methods ``request`` and ``request_raw`` represent the core. For all API
paths there are furthermore methods (e.g. posts_add for 'posts/all') with
an explicit declaration of the parameters and documentation. These all call
``request`` and pass on extra keywords like ``_raw``.
"""
def __init__(self, user, passwd, codec='iso-8859-1', api_request=dlcs_api_request, xml_parser=dlcs_parse_xml):
"""Initialize access to the API with ``user`` and ``passwd``.
``codec`` sets the encoding of the arguments.
The ``api_request`` and ``xml_parser`` parameters by default point to
functions within this package with standard implementations to
request and parse a resource. See ``dlcs_api_request()`` and
``dlcs_parse_xml()``. Note that ``api_request`` should return a
file-like instance with an HTTPMessage instance under ``info()``,
see ``urllib2.openurl`` for more info.
"""
assert user != ""
self.user = user
self.passwd = passwd
self.codec = codec
# Implement communication to server and parsing of respons messages:
assert callable(api_request)
self._api_request = api_request
assert callable(xml_parser)
self._parse_response = xml_parser
def _call_server(self, path, **params):
params = dict0(params)
for key in params:
params[key] = params[key].encode(self.codec)
# see __init__ for _api_request()
return self._api_request(path, params, self.user, self.passwd)
### Core functionality
def request(self, path, _raw=False, **params):
"""Calls a path in the API, parses the answer to a JSON-like structure by
default. Use with ``_raw=True`` or ``call request_raw()`` directly to
get the filehandler and process the response message manually.
Calls to some paths will return a `result` message, i.e.::
<result code="..." />
or::
<result>...</result>
These are all parsed to ``{'result':(Boolean, MessageString)}`` and this
method will raise ``DeliciousError`` on negative `result` answers. Using
``_raw=True`` bypasses all parsing and will never raise ``DeliciousError``.
See ``dlcs_parse_xml()`` and ``self.request_raw()``."""
# method _parse_response is bound in `__init__()`, `_call_server`
# uses `_api_request` also set in `__init__()`
if _raw:
# return answer
return self.request_raw(path, **params)
else:
# get answer and parse
fl = self._call_server(path, **params)
rs = self._parse_response(fl)
# Raise an error for negative 'result' answers
if type(rs) == dict and rs == 'result' and not rs['result'][0]:
errmsg = ""
if len(rs['result'])>0:
errmsg = rs['result'][1:]
raise DeliciousError, errmsg
return rs
def request_raw(self, path, **params):
"""Calls the path in the API, returns the filehandle. Returned
file-like instances have an ``HTTPMessage`` instance with HTTP header
information available. Use ``filehandle.info()`` or refer to the
``urllib2.openurl`` documentation.
"""
# see `request()` on how the response can be handled
return self._call_server(path, **params)
### Explicit declarations of API paths, their parameters and docs
# Tags
def tags_get(self, **kwds):
"""Returns a list of tags and the number of times it is used by the user.
::
<tags>
<tag tag="TagName" count="888">
"""
return self.request("tags/get", **kwds)
def tags_rename(self, old, new, **kwds):
"""Rename an existing tag with a new tag name. Returns a `result`
message or raises an ``DeliciousError``. See ``self.request()``.
&old (required)
Tag to rename.
&new (required)
New name.
"""
return self.request("tags/rename", old=old, new=new, **kwds)
# Posts
def posts_update(self, **kwds):
"""Returns the last update time for the user. Use this before calling
`posts_all` to see if the data has changed since the last fetch.
::
<update time="CCYY-MM-DDThh:mm:ssZ">
"""
return self.request("posts/update", **kwds)
def posts_dates(self, tag="", **kwds):
"""Returns a list of dates with the number of posts at each date.
::
<dates>
<date date="CCYY-MM-DD" count="888">
&tag (optional).
Filter by this tag.
"""
return self.request("posts/dates", tag=tag, **kwds)
def posts_get(self, tag="", dt="", url="", **kwds):
"""Returns posts matching the arguments. If no date or url is given,
most recent date will be used.
::
<posts dt="CCYY-MM-DD" tag="..." user="...">
<post ...>
&tag (optional).
Filter by this tag.
&dt (optional).
Filter by this date (CCYY-MM-DDThh:mm:ssZ).
&url (optional).
Filter by this url.
"""
return self.request("posts/get", tag=tag, dt=dt, url=url, **kwds)
def posts_recent(self, tag="", count="", **kwds):
"""Returns a list of the most recent posts, filtered by argument.
::
<posts tag="..." user="...">
<post ...>
&tag (optional).
Filter by this tag.
&count (optional).
Number of items to retrieve (Default:15, Maximum:100).
"""
return self.request("posts/recent", tag=tag, count=count, **kwds)
def posts_all(self, tag="", **kwds):
"""Returns all posts. Please use sparingly. Call the `posts_update`
method to see if you need to fetch this at all.
::
<posts tag="..." user="..." update="CCYY-MM-DDThh:mm:ssZ">
<post ...>
&tag (optional).
Filter by this tag.
"""
return self.request("posts/all", tag=tag, **kwds)
def posts_add(self, url, description, extended="", tags="", dt="",
replace="no", shared="yes", **kwds):
"""Add a post to del.icio.us. Returns a `result` message or raises an
``DeliciousError``. See ``self.request()``.
&url (required)
the url of the item.
&description (required)
the description of the item.
&extended (optional)
notes for the item.
&tags (optional)
tags for the item (space delimited).
&dt (optional)
datestamp of the item (format "CCYY-MM-DDThh:mm:ssZ").
Requires a LITERAL "T" and "Z" like in ISO8601 at http://www.cl.cam.ac.uk/~mgk25/iso-time.html for example: "1984-09-01T14:21:31Z"
&replace=no (optional) - don't replace post if given url has already been posted.
&shared=no (optional) - make the item private
"""
return self.request("posts/add", url=url, description=description,
extended=extended, tags=tags, dt=dt,
replace=replace, shared=shared, **kwds)
def posts_delete(self, url, **kwds):
"""Delete a post from del.icio.us. Returns a `result` message or
raises an ``DeliciousError``. See ``self.request()``.
&url (required)
the url of the item.
"""
return self.request("posts/delete", url=url, **kwds)
# Bundles
def bundles_all(self, **kwds):
"""Retrieve user bundles from del.icio.us.
::
<bundles>
<bundel name="..." tags=...">
"""
return self.request("tags/bundles/all", **kwds)
def bundles_set(self, bundle, tags, **kwds):
"""Assign a set of tags to a single bundle, wipes away previous
settings for bundle. Returns a `result` messages or raises an
``DeliciousError``. See ``self.request()``.
&bundle (required)
the bundle name.
&tags (required)
list of tags (space seperated).
"""
if type(tags)==list:
tags = " ".join(tags)
return self.request("tags/bundles/set", bundle=bundle, tags=tags,
**kwds)
def bundles_delete(self, bundle, **kwds):
"""Delete a bundle from del.icio.us. Returns a `result` message or
raises an ``DeliciousError``. See ``self.request()``.
&bundle (required)
the bundle name.
"""
return self.request("tags/bundles/delete", bundle=bundle, **kwds)
### Utils
# Lookup table for del.icio.us url-path to DeliciousAPI method.
paths = {
'tags/get': tags_get,
'tags/rename': tags_rename,
'posts/update': posts_update,
'posts/dates': posts_dates,
'posts/get': posts_get,
'posts/recent': posts_recent,
'posts/all': posts_all,
'posts/add': posts_add,
'posts/delete': posts_delete,
'tags/bundles/all': bundles_all,
'tags/bundles/set': bundles_set,
'tags/bundles/delete': bundles_delete,
}
def get_url(self, url):
"""Return the del.icio.us url at which the HTML page with posts for
``url`` can be found.
"""
return "http://del.icio.us/url/?url=%s" % (url,)
### Convenience functions on this package
def apiNew(user, passwd):
"""creates a new DeliciousAPI object.
requires user(name) and passwd
"""
return DeliciousAPI(user=user, passwd=passwd)
def add(user, passwd, url, description, tags="", extended="", dt="", replace="no"):
return apiNew(user, passwd).posts_add(url=url, description=description, extended=extended, tags=tags, dt=dt, replace=replace)
def get(user, passwd, tag="", dt="", count = 0):
posts = apiNew(user, passwd).posts_get(tag=tag,dt=dt)
if count != 0: posts = posts[0:count]
return posts
def get_all(user, passwd, tag=""):
return apiNew(user, passwd).posts_all(tag=tag)
def delete(user, passwd, url):
return apiNew(user, passwd).posts_delete(url=url)
def rename_tag(user, passwd, oldtag, newtag):
return apiNew(user=user, passwd=passwd).tags_rename(old=oldtag, new=newtag)
def get_tags(user, passwd):
return apiNew(user=user, passwd=passwd).tags_get()
### RSS functions bvb: still working...?
def getrss(tag="", popular=0, url='', user=""):
"""get posts from del.icio.us via parsing RSS (bvb:or HTML)
todo: not tested
tag (opt) sort by tag
popular (opt) look for the popular stuff
user (opt) get the posts by a user, this striks popular
url (opt) get the posts by url
"""
return dlcs_rss_request(tag=tag, popular=popular, user=user, url=url)
def get_userposts(user):
return getrss(user = user)
def get_tagposts(tag):
return getrss(tag = tag)
def get_urlposts(url):
return getrss(url = url)
def get_popular(tag = ""):
return getrss(tag = tag, popular = 1)
### TODO: implement JSON fetching
def json_posts(user, count=15):
"""http://del.icio.us/feeds/json/mpe
http://del.icio.us/feeds/json/mpe/art+history
count=### the number of posts you want to get (default is 15, maximum is 100)
raw a raw JSON object is returned, instead of an object named Delicious.posts
"""
def json_tags(user, atleast, count, sort='alpha'):
"""http://del.icio.us/feeds/json/tags/mpe
atleast=### include only tags for which there are at least ### number of posts
count=### include ### tags, counting down from the top
sort={alpha|count} construct the object with tags in alphabetic order (alpha), or by count of posts (count)
callback=NAME wrap the object definition in a function call NAME(...), thus invoking that function when the feed is executed
raw a pure JSON object is returned, instead of code that will construct an object named Delicious.tags
"""
def json_network(user):
"""http://del.icio.us/feeds/json/network/mpe
callback=NAME wrap the object definition in a function call NAME(...)
?raw a raw JSON object is returned, instead of an object named Delicious.posts
"""
def json_fans(user):
"""http://del.icio.us/feeds/json/fans/mpe
callback=NAME wrap the object definition in a function call NAME(...)
?raw a pure JSON object is returned, instead of an object named Delicious.
"""
|