alpcentaur
/
fdb-spider-interface
1
0
Fork 0
Code Issues 0 Pull Requests 0 Projects 0 Releases 0 Wiki Activity
The Interface of the fdb-spider, based on rocketchat
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
40 Commits
1 Branch
784 KiB
 
Tree: 0cc5177c8a
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '0cc5177c8a'
${ noResults }
 ZIP  TAR.GZ
alpcentaur 0cc5177c8a bugfix for command syntax change of updaterooms all 9 months ago
roomhistories added first updaterooms all command syntax change instead of only updaterooms updating all rooms 9 months ago
.gitignore added room commands first structure 11 months ago
README.md used different figlet output for README.md main header 9 months ago
config_example.ini also added user_id of bot to config 11 months ago
fdb_spider_interface.py bugfix for command syntax change of updaterooms all 9 months ago
new_message_file.txt bugfix for command syntax change of updaterooms all 9 months ago
requirements.txt added dateutil to requirements.txt, added parsing the period from fdb-spider output 9 months ago

README.md 

  __     _ _                     _     _                _       _            
 / _| __| | |__        ___ _ __ (_) __| | ___ _ __     (_)_ __ | |_ ___ _ __ 
| |_ / _` | '_ \ _____/ __| '_ \| |/ _` |/ _ \ '__|____| | '_ \| __/ _ \ '__|
|  _| (_| | |_) |_____\__ \ |_) | | (_| |  __/ | |_____| | | | | ||  __/ |   
|_|  \__,_|_.__/      |___/ .__/|_|\__,_|\___|_|       |_|_| |_|\__\___|_|   
                          |_|                                                
  __                
 / _| __ _  ___ ___ 
| |_ / _` |/ __/ _ \
|  _| (_| | (_|  __/
|_|  \__,_|\___\___|
  1. Introduction
  2. Installation
  3. Usage

Introduction

The fdb-spider-interface is an interface for the fdb-spider. It is based on rocketchat, and displaying entries such as programming tag search can be done within any rocketchat client.

In future, the bot based code will migrate from rocketchat to matrix.

Installation

To use this spider, you need to have a Rocketchat Server.

On your Rocketchat Server, create a new user with the role bot. Put the right password and username in config.ini. Create a private channel, add the bot to the channel, then run the code

api = RocketChatAPI(settings={'username': botname, 'password': botpassword, 'domain': server_url})

rooms = api.get_private_rooms()

print(rooms)

From there, copy the room_id to

config.ini

which you want to be the room in which you talk to the interface bot.

For the bot_user_id run the commands

myinfo = api.get_my_info()
print(myinfo)

Information: It is important to change the settings for bots, otherwise with the standard rocketchat configuration the fdb-spider-interface will get too many requests errors and stop working eventually.

Usage

Important Commands

There is actually only one important command to remember and that is

printcommands

That will output all available commands with explanations.

Generally, you can create new tag search "rooms" where the interface will run updates.

createroom

will create a room where you can monitor your custom tag based search outputs.

printrooms

will print all configured rooms,

addtags

will add tags to the tag search of a specific room, etc.

Specify the update interval and time in config.ini, and choose it appropriate to your updates you give to the fdb-spider output (by running the fdb-spider for example once a week with cron)