mirror of
https://codeberg.org/sch/BukuBot
synced 2024-11-17 11:38:41 +01:00
100 lines
3.9 KiB
Python
100 lines
3.9 KiB
Python
|
#!/usr/bin/env python3
|
||
|
|
# -*- coding: utf-8 -*-
|
||
|
|
|
||
|
|
class Documentation:
|
||
|
|
|
||
|
|
def about():
|
||
|
|
return ('BukuBot'
|
||
|
|
'\n'
|
||
|
|
'Jabber/XMPP Bookmark Manager'
|
||
|
|
'\n\n'
|
||
|
|
'BukuBot is an XMPP bot that facilitates accessing and '
|
||
|
|
'managing bookmarks remotely.'
|
||
|
|
'\n\n'
|
||
|
|
'BukuBot is written in Python'
|
||
|
|
'\n\n'
|
||
|
|
'It is utilizing buku to handle bookmarks, and slixmpp to '
|
||
|
|
'communicate in the XMPP telecommunication network.'
|
||
|
|
'\n\n'
|
||
|
|
'https://git.xmpp-it.net/sch/BukuBot'
|
||
|
|
'\n\n'
|
||
|
|
'Copyright 2024 Schimon Jehudah Zackary'
|
||
|
|
'\n\n'
|
||
|
|
'Made in Switzerland'
|
||
|
|
'\n\n'
|
||
|
|
'🇨🇭️')
|
||
|
|
|
||
|
|
def commands():
|
||
|
|
return ("add URL [tag1,tag2,tag3,...]"
|
||
|
|
"\n"
|
||
|
|
" Bookmark URL along with comma-separated tags."
|
||
|
|
"\n\n"
|
||
|
|
"mod name <ID> <TEXT>"
|
||
|
|
"\n"
|
||
|
|
" Modify bookmark title."
|
||
|
|
"\n"
|
||
|
|
"mod note <ID> <TEXT>"
|
||
|
|
"\n"
|
||
|
|
" Modify bookmark description."
|
||
|
|
"\n"
|
||
|
|
"tag [+|-] <ID> [tag1,tag2,tag3,...]"
|
||
|
|
"\n"
|
||
|
|
" Modify bookmark tags. Appends or deletes tags, if flag tag "
|
||
|
|
"is preceded by \'+\' or \'-\' respectively."
|
||
|
|
"\n"
|
||
|
|
"del <ID> or <URL>"
|
||
|
|
"\n"
|
||
|
|
" Delete a bookmark by ID or URL."
|
||
|
|
"\n"
|
||
|
|
"\n"
|
||
|
|
"id <ID>"
|
||
|
|
"\n"
|
||
|
|
" Print a bookmark by ID."
|
||
|
|
"\n"
|
||
|
|
"last"
|
||
|
|
"\n"
|
||
|
|
" Print most recently bookmarked item."
|
||
|
|
"\n"
|
||
|
|
"tag <TEXT>"
|
||
|
|
"\n"
|
||
|
|
" Search bookmarks of given tag."
|
||
|
|
"\n"
|
||
|
|
"search <TEXT>"
|
||
|
|
"\n"
|
||
|
|
" Search bookmarks by a given search query."
|
||
|
|
"\n"
|
||
|
|
"search any <TEXT>"
|
||
|
|
"\n"
|
||
|
|
" Search bookmarks by a any given keyword."
|
||
|
|
# "\n"
|
||
|
|
# "regex"
|
||
|
|
# "\n"
|
||
|
|
# " Search bookmarks using Regular Expression."
|
||
|
|
"\n")
|
||
|
|
|
||
|
|
def notice():
|
||
|
|
return ('Copyright 2024 Schimon Jehudah Zackary'
|
||
|
|
'\n\n'
|
||
|
|
'Permission is hereby granted, free of charge, to any person '
|
||
|
|
'obtaining a copy of this software and associated '
|
||
|
|
'documentation files (the “Software”), to deal in the '
|
||
|
|
'Software without restriction, including without limitation '
|
||
|
|
'the rights to use, copy, modify, merge, publish, distribute, '
|
||
|
|
'sublicense, and/or sell copies of the Software, and to '
|
||
|
|
'permit persons to whom the Software is furnished to do so, '
|
||
|
|
'subject to the following conditions:'
|
||
|
|
'\n\n'
|
||
|
|
'The above copyright notice and this permission notice shall '
|
||
|
|
'be included in all copies or substantial portions of the '
|
||
|
|
'Software.'
|
||
|
|
'\n\n'
|
||
|
|
'THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY '
|
||
|
|
'KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE '
|
||
|
|
'WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR '
|
||
|
|
'PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR '
|
||
|
|
'COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER '
|
||
|
|
'LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR '
|
||
|
|
'OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE '
|
||
|
|
'SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.')
|
||
|
|
|