[#813] added .atom to import/export extensions

Author: LeXofLeviafan

README.md

@@ -68,7 +68,7 @@ To get started right away, jump to the [Quickstart](#quickstart) section. `buku`
 - Powerful search options (regex, substring...)
 - Continuous search with on the fly mode switch
 - Portable, merge-able database to sync between systems
-- Import/export bookmarks from/to HTML, XBEL, Markdown, RSS or Orgfile
+- Import/export bookmarks from/to HTML, XBEL, Markdown, RSS/Atom or Orgfile
 - Smart tag management using redirection (>>, >, <<)
 - Multi-threaded full DB refresh
 - Manual encryption support
@@ -232,11 +232,11 @@ POWER TOYS:
                            format: [title](url) <!-- TAGS -->
                            export Orgfile, if file ends with '.org'
                            format: *[[url][title]] :tags:
-                           export rss feed if file ends with '.rss'
+                           export rss feed if file ends with '.rss'/'.atom'
                            export buku DB, if file ends with '.db'
                            combines with search results, if opted
       -i, --import file    import bookmarks from file
-                           supports .html .xbel .json .md .org .rss .db
+                           supports .html .xbel .json .md .org .rss .atom .db
       -p, --print [...]    show record details by indices, ranges
                            print all bookmarks, if no arguments
                            -n shows the last n results (like tail)

buku

@@ -2632,6 +2632,8 @@ class BukuDb:
         exported to an org file.
         If destination file name ends with '.xbel' bookmarks are
         exported to a XBEL file.
+        If destination file name ends with '.rss'/'.atom' bookmarks are
+        exported to an RSS file.
         Otherwise, bookmarks are exported to a Firefox bookmarks.html
         formatted file.
 
@@ -2712,7 +2714,7 @@ class BukuDb:
                 res = convert_bookmark_set(resultset, 'xbel', old)
                 count += res['count']
                 outfp.write(res['data'])
-            elif filepath.endswith('.rss'):
+            elif filepath.endswith('.rss') or filepath.endswith('.atom'):
                 res = convert_bookmark_set(resultset, 'rss', old)
                 count += res['count']
                 outfp.write(res['data'])
@@ -2992,7 +2994,8 @@ class BukuDb:
 
         Supports Firefox, Google Chrome, and IE exported HTML bookmarks.
         Supports XBEL standard bookmarks.
-        Supports Markdown files with extension '.md, .org'.
+        Supports RSS files with extension '.rss', '.atom'.
+        Supports Markdown files with extension '.md', '.org'.
         Supports importing bookmarks from another buku database file.
 
         Parameters
@@ -3026,7 +3029,7 @@ class BukuDb:
             items = import_md(filepath=filepath, newtag=newtag)
         elif filepath.endswith('org'):
             items = import_org(filepath=filepath, newtag=newtag)
-        elif filepath.endswith('rss'):
+        elif filepath.endswith('rss') or filepath.endswith('atom'):
             items = import_rss(filepath=filepath, newtag=newtag)
         elif filepath.endswith('json'):
             if not tacit:
@@ -5993,11 +5996,11 @@ POSITIONAL ARGUMENTS:
                          format: [title](url) <!-- TAGS -->
                          export Orgfile, if file ends with '.org'
                          format: *[[url][title]] :tags:
-                         export rss feed if file ends with '.rss'
+                         export rss feed if file ends with '.rss'/'.atom'
                          export buku DB, if file ends with '.db'
                          combines with search results, if opted
     -i, --import file    import bookmarks from file
-                         supports .html .xbel .json .md .org .rss .db
+                         supports .html .xbel .json .md .org .rss .atom .db
     -p, --print [...]    show record details by indices, ranges
                          print all bookmarks, if no arguments
                          -n shows the last n results (like tail)

buku.1

@@ -18,7 +18,7 @@ is a command-line utility to store, tag, search and organize bookmarks.
   * Powerful search options (regex, substring...)
   * Continuous search with on the fly mode switch
   * Portable, merge-able database to sync between systems
-  * Import/export bookmarks from/to HTML, XBEL, Markdown, RSS or Orgfile
+  * Import/export bookmarks from/to HTML, XBEL, Markdown, RSS/Atom or Orgfile
   * Smart tag management using redirection (>>, >, <<)
   * Multithreaded full DB refresh
   * Manual encryption support
@@ -241,7 +241,7 @@ has extension '.org' Orgfile format: * [[url][title]], 1 entry per line.
 .br
 RSS is used if
 .I file
-has extension '.rss' RSS format: <entry> per bookmark with <title>, <link>, <category>, <content> elements
+has extension '.rss'/'.atom' RSS format: <entry> per bookmark with <title>, <link>, <category>, <content> elements
 .br
 A buku database is generated if
 .I file
@@ -250,7 +250,7 @@ has extension '.db'.
 .BI \-i " " \--import " file"
 Import bookmarks from Firefox bookmarks formatted HTML.
 .I file
-is considered Firefox-exported JSON if it has '.json' extension, XBEL if it is '.xbel', Markdown (compliant with --export format) if it is '.md', Orgfile if the extension is '.org', RSS if the extension is '.rss' or another buku database if the extension is '.db'.
+is considered Firefox-exported JSON if it has '.json' extension, XBEL if it is '.xbel', Markdown (compliant with --export format) if it is '.md', Orgfile if the extension is '.org', RSS if the extension is '.rss'/'.atom' or another buku database if the extension is '.db'.
 .TP
 .BI \-p " " \--print " [...]"
 Show details (DB index, URL, title, tags and comment) of bookmark record by DB index. If no arguments, all records with actual index from DB are shown. Accepts hyphenated ranges and space-separated indices. A negative value (introduced for convenience) behaves like the tail utility, e.g., -n shows the details of the last n bookmarks.

tests/test_buku.py

@@ -609,17 +609,15 @@ def test_import_md(tmpdir, url, title, tags, newtag, exp_tags):
     assert res == ([] if not url else  # `<>` and `[title]()` are not valid
                    [(url, title or '', exp_tags, None, 0, True, False)])
 
-@pytest.mark.parametrize(
-    "newtag, exp_res",
-    [
-        (None, ("http://example.com", "text1", ",", None, 0, True, False)),
-        ("tag1", ("http://example.com", "text1", ",tag1,", None, 0, True, False)),
-    ],
-)
-def test_import_rss(tmpdir, newtag, exp_res):
+@pytest.mark.parametrize('newtag, exp_res', [
+    (None, ('http://example.com', 'text1', ',', None, 0, True, False)),
+    ('tag1', ('http://example.com', 'text1', ',tag1,', None, 0, True, False)),
+])
+@pytest.mark.parametrize('extension', ['.rss', '.atom'])
+def test_import_rss(tmpdir, extension, newtag, exp_res):
     from buku import import_rss
 
-    p = tmpdir.mkdir("importrss").join("test.rss")
+    p = tmpdir.mkdir('importrss').join('test' + extension)
     p.write(
         '<feed xmlns="http://www.w3.org/2005/Atom">\n'
         '    <title>Bookmarks</title>\n'

tests/test_bukuDb.py

@@ -1038,7 +1038,7 @@ def custom_fetch(url, http_head=False):
               '        <title>Welcome to Python.org</title>',
               '        <desc>The official home...</desc>',
               '    </bookmark>',
-              '</xbel>',]),
+              '</xbel>']),
     ('html', ['<!DOCTYPE NETSCAPE-Bookmark-file-1>', '',
               '<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8">',
               '<TITLE>Bookmarks</TITLE>', '<H1>Bookmarks</H1>', '',
@@ -1055,6 +1055,54 @@ def custom_fetch(url, http_head=False):
               '        <DD>The official home...',
               '    </DL><p>',
               '</DL><p>']),
+    ('rss', ['<feed xmlns="http://www.w3.org/2005/Atom">',
+             '    <title>Bookmarks</title>',
+             '    <generator uri="https://github.com/jarun/buku">buku</generator>',
+             '    <entry>',
+             '        <title>Fetched Title (DELETED)</title>',
+             '        <link href="http://custom.url" rel="alternate" type="text/html"/>',
+             '        <id>1</id>',  # deleted entry, pre-deletion ID
+             '        <content type="html"> <![CDATA[ <p>Fetched description.</p> ]]> </content>',
+             '    </entry>',
+             '    <entry>',
+             '        <title>Wikipedia (OLD URL = http://wikipedia.net)</title>',
+             '        <link href="https://www.wikipedia.org" rel="alternate" type="text/html"/>',
+             '        <id>1</id>',  # updated entry, current ID
+             '        <category term="http:301"/>',
+             '        <content type="html"> <![CDATA[ <p>Wikipedia is a free...</p> ]]> </content>',
+             '    </entry>',
+             '    <entry>',
+             '        <title>Welcome to Python.org</title>',
+             '        <link href="https://python.org/notfound" rel="alternate" type="text/html"/>',
+             '        <id>2</id>',
+             '        <category term="http:404"/>',
+             '        <content type="html"> <![CDATA[ <p>The official home...</p> ]]> </content>',
+             '    </entry>',
+             '</feed>']),
+    ('atom', ['<feed xmlns="http://www.w3.org/2005/Atom">',
+              '    <title>Bookmarks</title>',
+              '    <generator uri="https://github.com/jarun/buku">buku</generator>',
+              '    <entry>',
+              '        <title>Fetched Title (DELETED)</title>',
+              '        <link href="http://custom.url" rel="alternate" type="text/html"/>',
+              '        <id>1</id>',  # deleted entry, pre-deletion ID
+              '        <content type="html"> <![CDATA[ <p>Fetched description.</p> ]]> </content>',
+              '    </entry>',
+              '    <entry>',
+              '        <title>Wikipedia (OLD URL = http://wikipedia.net)</title>',
+              '        <link href="https://www.wikipedia.org" rel="alternate" type="text/html"/>',
+              '        <id>1</id>',  # updated entry, current ID
+              '        <category term="http:301"/>',
+              '        <content type="html"> <![CDATA[ <p>Wikipedia is a free...</p> ]]> </content>',
+              '    </entry>',
+              '    <entry>',
+              '        <title>Welcome to Python.org</title>',
+              '        <link href="https://python.org/notfound" rel="alternate" type="text/html"/>',
+              '        <id>2</id>',
+              '        <category term="http:404"/>',
+              '        <content type="html"> <![CDATA[ <p>The official home...</p> ]]> </content>',
+              '    </entry>',
+              '</feed>']),
 ])
 def test_export_on(bukuDb, ext, expected):
     '''Testing exportdb() behaviour after update_rec() with export_on'''